telnyx 5.0.0 → 5.1.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 +38 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +4 -0
- data/lib/telnyx/internal/type/union.rb +1 -1
- data/lib/telnyx/models/ai/assistant.rb +39 -4
- data/lib/telnyx/models/ai/assistant_create_params.rb +187 -6
- data/lib/telnyx/models/ai/assistant_imports_params.rb +10 -1
- data/lib/telnyx/models/ai/assistant_tool.rb +400 -3
- data/lib/telnyx/models/ai/assistant_update_params.rb +187 -6
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +189 -6
- data/lib/telnyx/models/ai/bucket_ids.rb +7 -1
- data/lib/telnyx/models/ai/chat_create_completion_params.rb +4 -4
- data/lib/telnyx/models/ai/inference_embedding.rb +187 -6
- data/lib/telnyx/models/ai/messaging_settings.rb +10 -1
- data/lib/telnyx/models/ai/retrieval_tool.rb +3 -3
- data/lib/telnyx/models/ai/telephony_settings.rb +142 -1
- data/lib/telnyx/models/ai/transfer_tool.rb +46 -3
- data/lib/telnyx/models/ai/voice_settings.rb +1 -1
- data/lib/telnyx/models/ai/webhook_tool.rb +256 -3
- data/lib/telnyx/models/call_control_application_list_params.rb +16 -18
- data/lib/telnyx/models/call_event_list_params.rb +16 -18
- data/lib/telnyx/models/calls/action_add_ai_assistant_messages_params.rb +289 -0
- data/lib/telnyx/models/calls/action_add_ai_assistant_messages_response.rb +18 -0
- data/lib/telnyx/models/calls/action_start_noise_suppression_params.rb +7 -4
- data/lib/telnyx/models/conference_list_params.rb +16 -18
- data/lib/telnyx/models/conference_list_participants_params.rb +16 -18
- data/lib/telnyx/models/connection_list_active_calls_params.rb +16 -18
- data/lib/telnyx/models/fax_create_params.rb +10 -1
- data/lib/telnyx/models/messaging_10dlc/brand_retrieve_sms_otp_status_params.rb +1 -9
- data/lib/telnyx/models/messaging_profile.rb +11 -1
- data/lib/telnyx/models/messaging_profile_create_params.rb +11 -1
- data/lib/telnyx/models/messaging_profile_update_params.rb +11 -1
- data/lib/telnyx/models/messaging_tollfree/verification/tf_verification_request.rb +14 -1
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb +17 -1
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_status.rb +17 -1
- data/lib/telnyx/models/organizations/user_get_groups_report_params.rb +32 -0
- data/lib/telnyx/models/organizations/user_get_groups_report_response.rb +132 -0
- data/lib/telnyx/models/organizations/user_list_params.rb +73 -0
- data/lib/telnyx/models/organizations/user_list_response.rb +118 -0
- data/lib/telnyx/models/organizations/user_retrieve_params.rb +29 -0
- data/lib/telnyx/models/organizations/user_retrieve_response.rb +129 -0
- data/lib/telnyx/models/organizations/users/action_remove_params.rb +18 -0
- data/lib/telnyx/models/organizations/users/action_remove_response.rb +133 -0
- data/lib/telnyx/models/private_wireless_gateway_status.rb +3 -2
- data/lib/telnyx/models/queues/call_list_params.rb +16 -18
- data/lib/telnyx/models/sim_card_list_params.rb +11 -3
- data/lib/telnyx/models/texml/accounts/queue_list_params.rb +64 -0
- data/lib/telnyx/models/texml/accounts/queue_list_response.rb +155 -0
- data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +1 -7
- data/lib/telnyx/models/unwrap_webhook_event.rb +1 -7
- data/lib/telnyx/models.rb +2 -6
- data/lib/telnyx/resources/ai/assistants/tools.rb +2 -2
- data/lib/telnyx/resources/ai/assistants/versions.rb +18 -16
- data/lib/telnyx/resources/ai/assistants.rb +15 -9
- data/lib/telnyx/resources/ai/clusters.rb +1 -1
- data/lib/telnyx/resources/ai/embeddings.rb +1 -1
- data/lib/telnyx/resources/bundle_pricing/user_bundles.rb +1 -1
- data/lib/telnyx/resources/call_control_applications.rb +8 -4
- data/lib/telnyx/resources/call_events.rb +8 -4
- data/lib/telnyx/resources/calls/actions.rb +31 -0
- data/lib/telnyx/resources/conferences.rb +16 -8
- data/lib/telnyx/resources/connections.rb +8 -4
- data/lib/telnyx/resources/faxes.rb +3 -1
- data/lib/telnyx/resources/messages.rb +1 -1
- data/lib/telnyx/resources/messaging_10dlc/brand.rb +10 -14
- data/lib/telnyx/resources/messaging_profiles/autoresp_configs.rb +6 -6
- data/lib/telnyx/resources/messaging_profiles.rb +6 -2
- data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb +6 -2
- data/lib/telnyx/resources/operator_connect/actions.rb +1 -1
- data/lib/telnyx/resources/organizations/users/actions.rb +38 -0
- data/lib/telnyx/resources/organizations/users.rb +114 -0
- data/lib/telnyx/resources/organizations.rb +18 -0
- data/lib/telnyx/resources/phone_numbers/jobs.rb +1 -1
- data/lib/telnyx/resources/queues/calls.rb +8 -4
- data/lib/telnyx/resources/sim_cards/actions.rb +6 -6
- data/lib/telnyx/resources/texml/accounts/calls/recordings.rb +1 -1
- data/lib/telnyx/resources/texml/accounts/queues.rb +41 -0
- data/lib/telnyx/resources/usage_reports.rb +2 -2
- data/lib/telnyx/resources/webhooks.rb +2 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +15 -69
- data/rbi/telnyx/client.rbi +3 -0
- data/rbi/telnyx/models/ai/assistant.rbi +91 -5
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +449 -14
- data/rbi/telnyx/models/ai/assistant_imports_params.rbi +13 -0
- data/rbi/telnyx/models/ai/assistant_tool.rbi +910 -2
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +449 -14
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +454 -17
- data/rbi/telnyx/models/ai/bucket_ids.rbi +6 -0
- data/rbi/telnyx/models/ai/chat_create_completion_params.rbi +6 -13
- data/rbi/telnyx/models/ai/inference_embedding.rbi +447 -13
- data/rbi/telnyx/models/ai/messaging_settings.rbi +13 -0
- data/rbi/telnyx/models/ai/retrieval_tool.rbi +4 -8
- data/rbi/telnyx/models/ai/telephony_settings.rbi +347 -3
- data/rbi/telnyx/models/ai/transfer_tool.rbi +87 -6
- data/rbi/telnyx/models/ai/voice_settings.rbi +2 -2
- data/rbi/telnyx/models/ai/webhook_tool.rbi +584 -8
- data/rbi/telnyx/models/call_control_application_list_params.rbi +23 -35
- data/rbi/telnyx/models/call_event_list_params.rbi +23 -35
- data/rbi/telnyx/models/calls/action_add_ai_assistant_messages_params.rbi +583 -0
- data/rbi/telnyx/models/calls/action_add_ai_assistant_messages_response.rbi +39 -0
- data/rbi/telnyx/models/calls/action_start_noise_suppression_params.rbi +14 -6
- data/rbi/telnyx/models/conference_list_params.rbi +23 -35
- data/rbi/telnyx/models/conference_list_participants_params.rbi +23 -35
- data/rbi/telnyx/models/connection_list_active_calls_params.rbi +23 -35
- data/rbi/telnyx/models/fax_create_params.rbi +13 -0
- data/rbi/telnyx/models/messaging_10dlc/brand_retrieve_sms_otp_status_params.rbi +5 -21
- data/rbi/telnyx/models/messaging_profile.rbi +15 -0
- data/rbi/telnyx/models/messaging_profile_create_params.rbi +15 -0
- data/rbi/telnyx/models/messaging_profile_update_params.rbi +15 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbi +12 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbi +10 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_status.rbi +10 -0
- data/rbi/telnyx/models/organizations/user_get_groups_report_params.rbi +93 -0
- data/rbi/telnyx/models/organizations/user_get_groups_report_response.rbi +253 -0
- data/rbi/telnyx/models/organizations/user_list_params.rbi +152 -0
- data/rbi/telnyx/models/organizations/user_list_response.rbi +231 -0
- data/rbi/telnyx/models/organizations/user_retrieve_params.rbi +55 -0
- data/rbi/telnyx/models/organizations/user_retrieve_response.rbi +275 -0
- data/rbi/telnyx/models/organizations/users/action_remove_params.rbi +34 -0
- data/rbi/telnyx/models/organizations/users/action_remove_response.rbi +282 -0
- data/rbi/telnyx/models/private_wireless_gateway_status.rbi +4 -2
- data/rbi/telnyx/models/queues/call_list_params.rbi +23 -35
- data/rbi/telnyx/models/sim_card_list_params.rbi +14 -3
- data/rbi/telnyx/models/texml/accounts/queue_list_params.rbi +103 -0
- data/rbi/telnyx/models/texml/accounts/queue_list_response.rbi +269 -0
- data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +0 -3
- data/rbi/telnyx/models/unwrap_webhook_event.rbi +0 -3
- data/rbi/telnyx/models.rbi +2 -6
- data/rbi/telnyx/resources/ai/assistants/tools.rbi +2 -2
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +26 -19
- data/rbi/telnyx/resources/ai/assistants.rbi +32 -14
- data/rbi/telnyx/resources/ai/chat.rbi +1 -1
- data/rbi/telnyx/resources/ai/clusters.rbi +1 -1
- data/rbi/telnyx/resources/ai/embeddings.rbi +1 -1
- data/rbi/telnyx/resources/bundle_pricing/user_bundles.rbi +1 -1
- data/rbi/telnyx/resources/call_control_applications.rbi +7 -1
- data/rbi/telnyx/resources/call_events.rbi +5 -1
- data/rbi/telnyx/resources/calls/actions.rbi +37 -2
- data/rbi/telnyx/resources/conferences.rbi +10 -2
- data/rbi/telnyx/resources/connections.rbi +5 -1
- data/rbi/telnyx/resources/faxes.rbi +4 -0
- data/rbi/telnyx/resources/messages.rbi +1 -1
- data/rbi/telnyx/resources/messaging_10dlc/brand.rbi +8 -11
- data/rbi/telnyx/resources/messaging_profiles/autoresp_configs.rbi +6 -6
- data/rbi/telnyx/resources/messaging_profiles.rbi +10 -0
- data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi +10 -0
- data/rbi/telnyx/resources/operator_connect/actions.rbi +1 -1
- data/rbi/telnyx/resources/organizations/users/actions.rbi +32 -0
- data/rbi/telnyx/resources/organizations/users.rbi +88 -0
- data/rbi/telnyx/resources/organizations.rbi +15 -0
- data/rbi/telnyx/resources/phone_numbers/jobs.rbi +1 -1
- data/rbi/telnyx/resources/queues/calls.rbi +5 -1
- data/rbi/telnyx/resources/sim_cards/actions.rbi +6 -6
- data/rbi/telnyx/resources/sim_cards.rbi +1 -1
- data/rbi/telnyx/resources/texml/accounts/calls/recordings.rbi +1 -1
- data/rbi/telnyx/resources/texml/accounts/queues.rbi +32 -0
- data/rbi/telnyx/resources/usage_reports.rbi +2 -2
- data/rbi/telnyx/resources/webhooks.rbi +0 -6
- data/sig/telnyx/client.rbs +2 -0
- data/sig/telnyx/models/ai/assistant.rbs +44 -1
- data/sig/telnyx/models/ai/assistant_create_params.rbs +176 -1
- data/sig/telnyx/models/ai/assistant_imports_params.rbs +8 -1
- data/sig/telnyx/models/ai/assistant_tool.rbs +367 -2
- data/sig/telnyx/models/ai/assistant_update_params.rbs +176 -1
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +178 -3
- data/sig/telnyx/models/ai/chat_create_completion_params.rbs +4 -7
- data/sig/telnyx/models/ai/inference_embedding.rbs +178 -3
- data/sig/telnyx/models/ai/messaging_settings.rbs +7 -0
- data/sig/telnyx/models/ai/retrieval_tool.rbs +4 -4
- data/sig/telnyx/models/ai/telephony_settings.rbs +133 -4
- data/sig/telnyx/models/ai/transfer_tool.rbs +42 -4
- data/sig/telnyx/models/ai/webhook_tool.rbs +241 -4
- data/sig/telnyx/models/call_control_application_list_params.rbs +17 -26
- data/sig/telnyx/models/call_event_list_params.rbs +18 -27
- data/sig/telnyx/models/calls/action_add_ai_assistant_messages_params.rbs +240 -0
- data/sig/telnyx/models/calls/action_add_ai_assistant_messages_response.rbs +20 -0
- data/sig/telnyx/models/calls/action_start_noise_suppression_params.rbs +2 -1
- data/sig/telnyx/models/conference_list_params.rbs +17 -26
- data/sig/telnyx/models/conference_list_participants_params.rbs +17 -26
- data/sig/telnyx/models/connection_list_active_calls_params.rbs +20 -27
- data/sig/telnyx/models/fax_create_params.rbs +7 -0
- data/sig/telnyx/models/messaging_10dlc/brand_retrieve_sms_otp_status_params.rbs +3 -13
- data/sig/telnyx/models/messaging_profile.rbs +7 -0
- data/sig/telnyx/models/messaging_profile_create_params.rbs +7 -0
- data/sig/telnyx/models/messaging_profile_update_params.rbs +7 -0
- data/sig/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbs +5 -0
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs +5 -0
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_status.rbs +5 -0
- data/sig/telnyx/models/organizations/user_get_groups_report_params.rbs +43 -0
- data/sig/telnyx/models/organizations/user_get_groups_report_response.rbs +104 -0
- data/sig/telnyx/models/organizations/user_list_params.rbs +72 -0
- data/sig/telnyx/models/organizations/user_list_response.rbs +99 -0
- data/sig/telnyx/models/organizations/user_retrieve_params.rbs +27 -0
- data/sig/telnyx/models/organizations/user_retrieve_response.rbs +118 -0
- data/sig/telnyx/models/organizations/users/action_remove_params.rbs +19 -0
- data/sig/telnyx/models/organizations/users/action_remove_response.rbs +122 -0
- data/sig/telnyx/models/queues/call_list_params.rbs +20 -27
- data/sig/telnyx/models/sim_card_list_params.rbs +7 -0
- data/sig/telnyx/models/texml/accounts/queue_list_params.rbs +60 -0
- data/sig/telnyx/models/texml/accounts/queue_list_response.rbs +152 -0
- data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +0 -3
- data/sig/telnyx/models/unwrap_webhook_event.rbs +0 -3
- data/sig/telnyx/models.rbs +2 -6
- data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -0
- data/sig/telnyx/resources/ai/assistants.rbs +3 -0
- data/sig/telnyx/resources/call_control_applications.rbs +3 -1
- data/sig/telnyx/resources/call_events.rbs +3 -1
- data/sig/telnyx/resources/calls/actions.rbs +8 -0
- data/sig/telnyx/resources/conferences.rbs +6 -2
- data/sig/telnyx/resources/connections.rbs +3 -1
- data/sig/telnyx/resources/faxes.rbs +1 -0
- data/sig/telnyx/resources/messaging_10dlc/brand.rbs +1 -2
- data/sig/telnyx/resources/messaging_profiles.rbs +2 -0
- data/sig/telnyx/resources/messaging_tollfree/verification/requests.rbs +2 -0
- data/sig/telnyx/resources/organizations/users/actions.rbs +16 -0
- data/sig/telnyx/resources/organizations/users.rbs +31 -0
- data/sig/telnyx/resources/organizations.rbs +9 -0
- data/sig/telnyx/resources/queues/calls.rbs +3 -1
- data/sig/telnyx/resources/texml/accounts/queues.rbs +10 -0
- data/sig/telnyx/resources/webhooks.rbs +0 -6
- metadata +47 -20
- data/lib/telnyx/models/ai/inference_embedding_bucket_ids.rb +0 -31
- data/lib/telnyx/models/ai/inference_embedding_transfer_tool_params.rb +0 -93
- data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +0 -265
- data/lib/telnyx/models/streaming_failed_webhook_event.rb +0 -15
- data/lib/telnyx/models/streaming_started_webhook_event.rb +0 -15
- data/lib/telnyx/models/streaming_stopped_webhook_event.rb +0 -15
- data/rbi/telnyx/models/ai/inference_embedding_bucket_ids.rbi +0 -54
- data/rbi/telnyx/models/ai/inference_embedding_transfer_tool_params.rbi +0 -185
- data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +0 -621
- data/rbi/telnyx/models/streaming_failed_webhook_event.rbi +0 -30
- data/rbi/telnyx/models/streaming_started_webhook_event.rbi +0 -30
- data/rbi/telnyx/models/streaming_stopped_webhook_event.rbi +0 -30
- data/sig/telnyx/models/ai/inference_embedding_bucket_ids.rbs +0 -26
- data/sig/telnyx/models/ai/inference_embedding_transfer_tool_params.rbs +0 -75
- data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +0 -242
- data/sig/telnyx/models/streaming_failed_webhook_event.rbs +0 -15
- data/sig/telnyx/models/streaming_started_webhook_event.rbs +0 -16
- data/sig/telnyx/models/streaming_stopped_webhook_event.rbs +0 -16
|
@@ -24,7 +24,7 @@ module Telnyx
|
|
|
24
24
|
#
|
|
25
25
|
# Create a new AI Assistant.
|
|
26
26
|
#
|
|
27
|
-
# @overload create(instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, privacy_settings: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, request_options: {})
|
|
27
|
+
# @overload create(instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, privacy_settings: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
|
|
28
28
|
#
|
|
29
29
|
# @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
|
|
30
30
|
#
|
|
@@ -52,12 +52,14 @@ module Telnyx
|
|
|
52
52
|
#
|
|
53
53
|
# @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
|
|
54
54
|
#
|
|
55
|
-
# @param tools [Array<Telnyx::Models::AI::
|
|
55
|
+
# @param tools [Array<Telnyx::Models::AI::AssistantTool::Webhook, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage>] The tools that the assistant can use. These may be templated with [dynamic varia
|
|
56
56
|
#
|
|
57
57
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
58
58
|
#
|
|
59
59
|
# @param voice_settings [Telnyx::Models::AI::VoiceSettings]
|
|
60
60
|
#
|
|
61
|
+
# @param widget_settings [Telnyx::Models::AI::AssistantCreateParams::WidgetSettings] Configuration settings for the assistant's web widget.
|
|
62
|
+
#
|
|
61
63
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
62
64
|
#
|
|
63
65
|
# @return [Telnyx::Models::AI::InferenceEmbedding]
|
|
@@ -104,7 +106,7 @@ module Telnyx
|
|
|
104
106
|
#
|
|
105
107
|
# Update an AI Assistant's attributes.
|
|
106
108
|
#
|
|
107
|
-
# @overload update(assistant_id, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, privacy_settings: nil, promote_to_main: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, request_options: {})
|
|
109
|
+
# @overload update(assistant_id, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, privacy_settings: nil, promote_to_main: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
|
|
108
110
|
#
|
|
109
111
|
# @param assistant_id [String]
|
|
110
112
|
#
|
|
@@ -136,12 +138,14 @@ module Telnyx
|
|
|
136
138
|
#
|
|
137
139
|
# @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
|
|
138
140
|
#
|
|
139
|
-
# @param tools [Array<Telnyx::Models::AI::
|
|
141
|
+
# @param tools [Array<Telnyx::Models::AI::AssistantTool::Webhook, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage>] The tools that the assistant can use. These may be templated with [dynamic varia
|
|
140
142
|
#
|
|
141
143
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
142
144
|
#
|
|
143
145
|
# @param voice_settings [Telnyx::Models::AI::VoiceSettings]
|
|
144
146
|
#
|
|
147
|
+
# @param widget_settings [Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings] Configuration settings for the assistant's web widget.
|
|
148
|
+
#
|
|
145
149
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
146
150
|
#
|
|
147
151
|
# @return [Telnyx::Models::AI::InferenceEmbedding]
|
|
@@ -198,11 +202,11 @@ module Telnyx
|
|
|
198
202
|
# This endpoint allows a client to send a chat message to a specific AI Assistant.
|
|
199
203
|
# The assistant processes the message and returns a relevant reply based on the
|
|
200
204
|
# current conversation context. Refer to the Conversation API to
|
|
201
|
-
# [create a conversation](https://developers.telnyx.com/api/
|
|
202
|
-
# [filter existing conversations](https://developers.telnyx.com/api
|
|
203
|
-
# [fetch messages for a conversation](https://developers.telnyx.com/api/
|
|
205
|
+
# [create a conversation](https://developers.telnyx.com/api-reference/conversations/create-a-conversation),
|
|
206
|
+
# [filter existing conversations](https://developers.telnyx.com/api-reference/conversations/list-conversations),
|
|
207
|
+
# [fetch messages for a conversation](https://developers.telnyx.com/api-reference/conversations/get-conversation-messages),
|
|
204
208
|
# and
|
|
205
|
-
# [manually add messages to a conversation](https://developers.telnyx.com/api/
|
|
209
|
+
# [manually add messages to a conversation](https://developers.telnyx.com/api-reference/conversations/create-message).
|
|
206
210
|
#
|
|
207
211
|
# @overload chat(assistant_id, content:, conversation_id:, name: nil, request_options: {})
|
|
208
212
|
#
|
|
@@ -275,12 +279,14 @@ module Telnyx
|
|
|
275
279
|
# imported will be overwritten with its latest version from the importing
|
|
276
280
|
# provider.
|
|
277
281
|
#
|
|
278
|
-
# @overload imports(api_key_ref:, provider:, request_options: {})
|
|
282
|
+
# @overload imports(api_key_ref:, provider:, import_ids: nil, request_options: {})
|
|
279
283
|
#
|
|
280
284
|
# @param api_key_ref [String] Integration secret pointer that refers to the API key for the external provider.
|
|
281
285
|
#
|
|
282
286
|
# @param provider [Symbol, Telnyx::Models::AI::AssistantImportsParams::Provider] The external provider to import assistants from.
|
|
283
287
|
#
|
|
288
|
+
# @param import_ids [Array<String>] Optional list of assistant IDs to import from the external provider. If not prov
|
|
289
|
+
#
|
|
284
290
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
285
291
|
#
|
|
286
292
|
# @return [Telnyx::Models::AI::AssistantsList]
|
|
@@ -79,7 +79,7 @@ module Telnyx
|
|
|
79
79
|
# {Telnyx::Models::AI::ClusterComputeParams} for more details.
|
|
80
80
|
#
|
|
81
81
|
# Starts a background task to compute how the data in an
|
|
82
|
-
# [embedded storage bucket](https://developers.telnyx.com/api/
|
|
82
|
+
# [embedded storage bucket](https://developers.telnyx.com/api-reference/embeddings/embed-documents)
|
|
83
83
|
# is clustered. This helps identify common themes and patterns in the data.
|
|
84
84
|
#
|
|
85
85
|
# @overload compute(bucket:, files: nil, min_cluster_size: nil, min_subcluster_size: nil, prefix: nil, request_options: {})
|
|
@@ -155,7 +155,7 @@ module Telnyx
|
|
|
155
155
|
# URL and its linked pages into a Telnyx Cloud Storage bucket. As soon as each
|
|
156
156
|
# webpage is added to the bucket, its content is immediately processed for
|
|
157
157
|
# embeddings, that can be used for
|
|
158
|
-
# [similarity search](https://developers.telnyx.com/api/
|
|
158
|
+
# [similarity search](https://developers.telnyx.com/api-reference/embeddings/search-for-documents)
|
|
159
159
|
# and [clustering](https://developers.telnyx.com/docs/inference/clusters).
|
|
160
160
|
#
|
|
161
161
|
# @overload url(bucket_name:, url:, request_options: {})
|
|
@@ -13,7 +13,7 @@ module Telnyx
|
|
|
13
13
|
#
|
|
14
14
|
# @param idempotency_key [String] Body param: Idempotency key for the request. Can be any UUID, but should always
|
|
15
15
|
#
|
|
16
|
-
# @param items [Array<Telnyx::Models::BundlePricing::UserBundleCreateParams::Item>] Body param
|
|
16
|
+
# @param items [Array<Telnyx::Models::BundlePricing::UserBundleCreateParams::Item>] Body param
|
|
17
17
|
#
|
|
18
18
|
# @param authorization_bearer [String] Header param: Authenticates the request with your Telnyx API V2 KEY
|
|
19
19
|
#
|
|
@@ -134,17 +134,21 @@ module Telnyx
|
|
|
134
134
|
#
|
|
135
135
|
# Return a list of call control applications.
|
|
136
136
|
#
|
|
137
|
-
# @overload list(filter: nil, page: nil, sort: nil, request_options: {})
|
|
137
|
+
# @overload list(filter: nil, page: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
|
|
138
138
|
#
|
|
139
139
|
# @param filter [Telnyx::Models::CallControlApplicationListParams::Filter] Consolidated filter parameter (deepObject style). Originally: filter[application
|
|
140
140
|
#
|
|
141
141
|
# @param page [Telnyx::Models::CallControlApplicationListParams::Page] Consolidated page parameter (deepObject style). Originally: page[after], page[be
|
|
142
142
|
#
|
|
143
|
+
# @param page_number [Integer]
|
|
144
|
+
#
|
|
145
|
+
# @param page_size [Integer]
|
|
146
|
+
#
|
|
143
147
|
# @param sort [Symbol, Telnyx::Models::CallControlApplicationListParams::Sort] Specifies the sort order for results. By default sorting direction is ascending.
|
|
144
148
|
#
|
|
145
149
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
146
150
|
#
|
|
147
|
-
# @return [Telnyx::Internal::
|
|
151
|
+
# @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::CallControlApplication>]
|
|
148
152
|
#
|
|
149
153
|
# @see Telnyx::Models::CallControlApplicationListParams
|
|
150
154
|
def list(params = {})
|
|
@@ -152,8 +156,8 @@ module Telnyx
|
|
|
152
156
|
@client.request(
|
|
153
157
|
method: :get,
|
|
154
158
|
path: "call_control_applications",
|
|
155
|
-
query: parsed,
|
|
156
|
-
page: Telnyx::Internal::
|
|
159
|
+
query: parsed.transform_keys(page_number: "page[number]", page_size: "page[size]"),
|
|
160
|
+
page: Telnyx::Internal::DefaultFlatPagination,
|
|
157
161
|
model: Telnyx::CallControlApplication,
|
|
158
162
|
options: options
|
|
159
163
|
)
|
|
@@ -12,15 +12,19 @@ module Telnyx
|
|
|
12
12
|
#
|
|
13
13
|
# **Note**: Only one `filter[occurred_at]` can be passed.
|
|
14
14
|
#
|
|
15
|
-
# @overload list(filter: nil, page: nil, request_options: {})
|
|
15
|
+
# @overload list(filter: nil, page: nil, page_number: nil, page_size: nil, request_options: {})
|
|
16
16
|
#
|
|
17
17
|
# @param filter [Telnyx::Models::CallEventListParams::Filter] Consolidated filter parameter (deepObject style). Originally: filter[application
|
|
18
18
|
#
|
|
19
19
|
# @param page [Telnyx::Models::CallEventListParams::Page] Consolidated page parameter (deepObject style). Originally: page[after], page[be
|
|
20
20
|
#
|
|
21
|
+
# @param page_number [Integer]
|
|
22
|
+
#
|
|
23
|
+
# @param page_size [Integer]
|
|
24
|
+
#
|
|
21
25
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
22
26
|
#
|
|
23
|
-
# @return [Telnyx::Internal::
|
|
27
|
+
# @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::CallEventListResponse>]
|
|
24
28
|
#
|
|
25
29
|
# @see Telnyx::Models::CallEventListParams
|
|
26
30
|
def list(params = {})
|
|
@@ -28,8 +32,8 @@ module Telnyx
|
|
|
28
32
|
@client.request(
|
|
29
33
|
method: :get,
|
|
30
34
|
path: "call_events",
|
|
31
|
-
query: parsed,
|
|
32
|
-
page: Telnyx::Internal::
|
|
35
|
+
query: parsed.transform_keys(page_number: "page[number]", page_size: "page[size]"),
|
|
36
|
+
page: Telnyx::Internal::DefaultFlatPagination,
|
|
33
37
|
model: Telnyx::Models::CallEventListResponse,
|
|
34
38
|
options: options
|
|
35
39
|
)
|
|
@@ -4,6 +4,37 @@ module Telnyx
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Calls
|
|
6
6
|
class Actions
|
|
7
|
+
# Some parameter documentations has been truncated, see
|
|
8
|
+
# {Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams} for more details.
|
|
9
|
+
#
|
|
10
|
+
# Add messages to the conversation started by an AI assistant on the call.
|
|
11
|
+
#
|
|
12
|
+
# @overload add_ai_assistant_messages(call_control_id, client_state: nil, command_id: nil, messages: nil, request_options: {})
|
|
13
|
+
#
|
|
14
|
+
# @param call_control_id [String] Unique identifier and token for controlling the call
|
|
15
|
+
#
|
|
16
|
+
# @param client_state [String] Use this field to add state to every subsequent webhook. It must be a valid Base
|
|
17
|
+
#
|
|
18
|
+
# @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
|
|
19
|
+
#
|
|
20
|
+
# @param messages [Array<Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::User, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Tool, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::System, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Developer>] The messages to add to the conversation.
|
|
21
|
+
#
|
|
22
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
23
|
+
#
|
|
24
|
+
# @return [Telnyx::Models::Calls::ActionAddAIAssistantMessagesResponse]
|
|
25
|
+
#
|
|
26
|
+
# @see Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams
|
|
27
|
+
def add_ai_assistant_messages(call_control_id, params = {})
|
|
28
|
+
parsed, options = Telnyx::Calls::ActionAddAIAssistantMessagesParams.dump_request(params)
|
|
29
|
+
@client.request(
|
|
30
|
+
method: :post,
|
|
31
|
+
path: ["calls/%1$s/actions/ai_assistant_add_messages", call_control_id],
|
|
32
|
+
body: parsed,
|
|
33
|
+
model: Telnyx::Models::Calls::ActionAddAIAssistantMessagesResponse,
|
|
34
|
+
options: options
|
|
35
|
+
)
|
|
36
|
+
end
|
|
37
|
+
|
|
7
38
|
# Some parameter documentations has been truncated, see
|
|
8
39
|
# {Telnyx::Models::Calls::ActionAnswerParams} for more details.
|
|
9
40
|
#
|
|
@@ -98,17 +98,21 @@ module Telnyx
|
|
|
98
98
|
# of active participants. Conferences are listed in descending order by
|
|
99
99
|
# `expires_at`.
|
|
100
100
|
#
|
|
101
|
-
# @overload list(filter: nil, page: nil, region: nil, request_options: {})
|
|
101
|
+
# @overload list(filter: nil, page: nil, page_number: nil, page_size: nil, region: nil, request_options: {})
|
|
102
102
|
#
|
|
103
103
|
# @param filter [Telnyx::Models::ConferenceListParams::Filter] Consolidated filter parameter (deepObject style). Originally: filter[application
|
|
104
104
|
#
|
|
105
105
|
# @param page [Telnyx::Models::ConferenceListParams::Page] Consolidated page parameter (deepObject style). Originally: page[after], page[be
|
|
106
106
|
#
|
|
107
|
+
# @param page_number [Integer]
|
|
108
|
+
#
|
|
109
|
+
# @param page_size [Integer]
|
|
110
|
+
#
|
|
107
111
|
# @param region [Symbol, Telnyx::Models::ConferenceListParams::Region] Region where the conference data is located
|
|
108
112
|
#
|
|
109
113
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
110
114
|
#
|
|
111
|
-
# @return [Telnyx::Internal::
|
|
115
|
+
# @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Conference>]
|
|
112
116
|
#
|
|
113
117
|
# @see Telnyx::Models::ConferenceListParams
|
|
114
118
|
def list(params = {})
|
|
@@ -116,8 +120,8 @@ module Telnyx
|
|
|
116
120
|
@client.request(
|
|
117
121
|
method: :get,
|
|
118
122
|
path: "conferences",
|
|
119
|
-
query: parsed,
|
|
120
|
-
page: Telnyx::Internal::
|
|
123
|
+
query: parsed.transform_keys(page_number: "page[number]", page_size: "page[size]"),
|
|
124
|
+
page: Telnyx::Internal::DefaultFlatPagination,
|
|
121
125
|
model: Telnyx::Conference,
|
|
122
126
|
options: options
|
|
123
127
|
)
|
|
@@ -128,7 +132,7 @@ module Telnyx
|
|
|
128
132
|
#
|
|
129
133
|
# Lists conference participants
|
|
130
134
|
#
|
|
131
|
-
# @overload list_participants(conference_id, filter: nil, page: nil, region: nil, request_options: {})
|
|
135
|
+
# @overload list_participants(conference_id, filter: nil, page: nil, page_number: nil, page_size: nil, region: nil, request_options: {})
|
|
132
136
|
#
|
|
133
137
|
# @param conference_id [String] Uniquely identifies the conference by id
|
|
134
138
|
#
|
|
@@ -136,11 +140,15 @@ module Telnyx
|
|
|
136
140
|
#
|
|
137
141
|
# @param page [Telnyx::Models::ConferenceListParticipantsParams::Page] Consolidated page parameter (deepObject style). Originally: page[after], page[be
|
|
138
142
|
#
|
|
143
|
+
# @param page_number [Integer]
|
|
144
|
+
#
|
|
145
|
+
# @param page_size [Integer]
|
|
146
|
+
#
|
|
139
147
|
# @param region [Symbol, Telnyx::Models::ConferenceListParticipantsParams::Region] Region where the conference data is located
|
|
140
148
|
#
|
|
141
149
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
142
150
|
#
|
|
143
|
-
# @return [Telnyx::Internal::
|
|
151
|
+
# @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::ConferenceListParticipantsResponse>]
|
|
144
152
|
#
|
|
145
153
|
# @see Telnyx::Models::ConferenceListParticipantsParams
|
|
146
154
|
def list_participants(conference_id, params = {})
|
|
@@ -148,8 +156,8 @@ module Telnyx
|
|
|
148
156
|
@client.request(
|
|
149
157
|
method: :get,
|
|
150
158
|
path: ["conferences/%1$s/participants", conference_id],
|
|
151
|
-
query: parsed,
|
|
152
|
-
page: Telnyx::Internal::
|
|
159
|
+
query: parsed.transform_keys(page_number: "page[number]", page_size: "page[size]"),
|
|
160
|
+
page: Telnyx::Internal::DefaultFlatPagination,
|
|
153
161
|
model: Telnyx::Models::ConferenceListParticipantsResponse,
|
|
154
162
|
options: options
|
|
155
163
|
)
|
|
@@ -62,15 +62,19 @@ module Telnyx
|
|
|
62
62
|
# SIP connections with webhook_url or xml_request_url, call control or texml.
|
|
63
63
|
# Returned results are cursor paginated.
|
|
64
64
|
#
|
|
65
|
-
# @overload list_active_calls(connection_id, page: nil, request_options: {})
|
|
65
|
+
# @overload list_active_calls(connection_id, page: nil, page_number: nil, page_size: nil, request_options: {})
|
|
66
66
|
#
|
|
67
67
|
# @param connection_id [String] Telnyx connection id
|
|
68
68
|
#
|
|
69
69
|
# @param page [Telnyx::Models::ConnectionListActiveCallsParams::Page] Consolidated page parameter (deepObject style). Originally: page[after], page[be
|
|
70
70
|
#
|
|
71
|
+
# @param page_number [Integer]
|
|
72
|
+
#
|
|
73
|
+
# @param page_size [Integer]
|
|
74
|
+
#
|
|
71
75
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
72
76
|
#
|
|
73
|
-
# @return [Telnyx::Internal::
|
|
77
|
+
# @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::ConnectionListActiveCallsResponse>]
|
|
74
78
|
#
|
|
75
79
|
# @see Telnyx::Models::ConnectionListActiveCallsParams
|
|
76
80
|
def list_active_calls(connection_id, params = {})
|
|
@@ -78,8 +82,8 @@ module Telnyx
|
|
|
78
82
|
@client.request(
|
|
79
83
|
method: :get,
|
|
80
84
|
path: ["connections/%1$s/active_calls", connection_id],
|
|
81
|
-
query: parsed,
|
|
82
|
-
page: Telnyx::Internal::
|
|
85
|
+
query: parsed.transform_keys(page_number: "page[number]", page_size: "page[size]"),
|
|
86
|
+
page: Telnyx::Internal::DefaultFlatPagination,
|
|
83
87
|
model: Telnyx::Models::ConnectionListActiveCallsResponse,
|
|
84
88
|
options: options
|
|
85
89
|
)
|
|
@@ -21,7 +21,7 @@ module Telnyx
|
|
|
21
21
|
# - `fax.delivered`
|
|
22
22
|
# - `fax.failed`
|
|
23
23
|
#
|
|
24
|
-
# @overload create(connection_id:, from:, to:, client_state: nil, from_display_name: nil, media_name: nil, media_url: nil, monochrome: nil, preview_format: nil, quality: nil, store_media: nil, store_preview: nil, t38_enabled: nil, webhook_url: nil, request_options: {})
|
|
24
|
+
# @overload create(connection_id:, from:, to:, black_threshold: nil, client_state: nil, from_display_name: nil, media_name: nil, media_url: nil, monochrome: nil, preview_format: nil, quality: nil, store_media: nil, store_preview: nil, t38_enabled: nil, webhook_url: nil, request_options: {})
|
|
25
25
|
#
|
|
26
26
|
# @param connection_id [String] The connection ID to send the fax with.
|
|
27
27
|
#
|
|
@@ -29,6 +29,8 @@ module Telnyx
|
|
|
29
29
|
#
|
|
30
30
|
# @param to [String] The phone number, in E.164 format, the fax will be sent to or SIP URI
|
|
31
31
|
#
|
|
32
|
+
# @param black_threshold [Integer] The black threshold percentage for monochrome faxes. Only applicable if `monochr
|
|
33
|
+
#
|
|
32
34
|
# @param client_state [String] Use this field to add state to every subsequent webhook. It must be a valid Base
|
|
33
35
|
#
|
|
34
36
|
# @param from_display_name [String] The `from_display_name` string to be used as the caller id name (SIP From Displa
|
|
@@ -9,7 +9,7 @@ module Telnyx
|
|
|
9
9
|
# Note: This API endpoint can only retrieve messages that are no older than 10
|
|
10
10
|
# days since their creation. If you require messages older than this, please
|
|
11
11
|
# generate an
|
|
12
|
-
# [MDR report.](https://developers.telnyx.com/api/
|
|
12
|
+
# [MDR report.](https://developers.telnyx.com/api-reference/mdr-usage-reports/create-mdr-usage-report)
|
|
13
13
|
#
|
|
14
14
|
# @overload retrieve(id, request_options: {})
|
|
15
15
|
#
|
|
@@ -295,37 +295,33 @@ module Telnyx
|
|
|
295
295
|
end
|
|
296
296
|
|
|
297
297
|
# Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand
|
|
298
|
-
# verification.
|
|
298
|
+
# verification using the Brand ID.
|
|
299
299
|
#
|
|
300
300
|
# This endpoint allows you to check the delivery and verification status of an OTP
|
|
301
|
-
# sent during the Sole Proprietor brand verification process
|
|
302
|
-
#
|
|
303
|
-
#
|
|
304
|
-
# - `referenceId` - The reference ID returned when the OTP was initially triggered
|
|
305
|
-
# - `brandId` - Query parameter for portal users to look up OTP status by Brand ID
|
|
301
|
+
# sent during the Sole Proprietor brand verification process by looking it up with
|
|
302
|
+
# the brand ID.
|
|
306
303
|
#
|
|
307
304
|
# The response includes delivery status, verification dates, and detailed delivery
|
|
308
305
|
# information.
|
|
309
306
|
#
|
|
310
|
-
#
|
|
307
|
+
# **Note:** This is an alternative to the `/10dlc/brand/smsOtp/{referenceId}`
|
|
308
|
+
# endpoint when you have the Brand ID but not the reference ID.
|
|
311
309
|
#
|
|
312
|
-
# @
|
|
310
|
+
# @overload retrieve_sms_otp_status(brand_id, request_options: {})
|
|
313
311
|
#
|
|
314
|
-
# @param brand_id [String]
|
|
312
|
+
# @param brand_id [String] The Brand ID for which to query OTP status
|
|
315
313
|
#
|
|
316
314
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
317
315
|
#
|
|
318
316
|
# @return [Telnyx::Models::Messaging10dlc::BrandRetrieveSMSOtpStatusResponse]
|
|
319
317
|
#
|
|
320
318
|
# @see Telnyx::Models::Messaging10dlc::BrandRetrieveSMSOtpStatusParams
|
|
321
|
-
def retrieve_sms_otp_status(
|
|
322
|
-
parsed, options = Telnyx::Messaging10dlc::BrandRetrieveSMSOtpStatusParams.dump_request(params)
|
|
319
|
+
def retrieve_sms_otp_status(brand_id, params = {})
|
|
323
320
|
@client.request(
|
|
324
321
|
method: :get,
|
|
325
|
-
path: ["10dlc/brand
|
|
326
|
-
query: parsed.transform_keys(brand_id: "brandId"),
|
|
322
|
+
path: ["10dlc/brand/%1$s/smsOtp", brand_id],
|
|
327
323
|
model: Telnyx::Models::Messaging10dlc::BrandRetrieveSMSOtpStatusResponse,
|
|
328
|
-
options:
|
|
324
|
+
options: params[:request_options]
|
|
329
325
|
)
|
|
330
326
|
end
|
|
331
327
|
|
|
@@ -58,17 +58,17 @@ module Telnyx
|
|
|
58
58
|
#
|
|
59
59
|
# @overload update(autoresp_cfg_id, profile_id:, country_code:, keywords:, op:, resp_text: nil, request_options: {})
|
|
60
60
|
#
|
|
61
|
-
# @param autoresp_cfg_id [String] Path param
|
|
61
|
+
# @param autoresp_cfg_id [String] Path param
|
|
62
62
|
#
|
|
63
|
-
# @param profile_id [String] Path param
|
|
63
|
+
# @param profile_id [String] Path param
|
|
64
64
|
#
|
|
65
|
-
# @param country_code [String] Body param
|
|
65
|
+
# @param country_code [String] Body param
|
|
66
66
|
#
|
|
67
|
-
# @param keywords [Array<String>] Body param
|
|
67
|
+
# @param keywords [Array<String>] Body param
|
|
68
68
|
#
|
|
69
|
-
# @param op [Symbol, Telnyx::Models::MessagingProfiles::AutoRespConfigCreate::Op] Body param
|
|
69
|
+
# @param op [Symbol, Telnyx::Models::MessagingProfiles::AutoRespConfigCreate::Op] Body param
|
|
70
70
|
#
|
|
71
|
-
# @param resp_text [String] Body param
|
|
71
|
+
# @param resp_text [String] Body param
|
|
72
72
|
#
|
|
73
73
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
74
74
|
#
|
|
@@ -11,7 +11,7 @@ module Telnyx
|
|
|
11
11
|
#
|
|
12
12
|
# Create a messaging profile
|
|
13
13
|
#
|
|
14
|
-
# @overload create(name:, whitelisted_destinations:, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, number_pool_settings: nil, url_shortener_settings: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
|
|
14
|
+
# @overload create(name:, whitelisted_destinations:, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, number_pool_settings: nil, smart_encoding: nil, url_shortener_settings: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
|
|
15
15
|
#
|
|
16
16
|
# @param name [String] A user friendly name for the messaging profile.
|
|
17
17
|
#
|
|
@@ -33,6 +33,8 @@ module Telnyx
|
|
|
33
33
|
#
|
|
34
34
|
# @param number_pool_settings [Telnyx::Models::NumberPoolSettings, nil] Number Pool allows you to send messages from a pool of numbers of different type
|
|
35
35
|
#
|
|
36
|
+
# @param smart_encoding [Boolean] Enables automatic character encoding optimization for SMS messages. When enabled
|
|
37
|
+
#
|
|
36
38
|
# @param url_shortener_settings [Telnyx::Models::URLShortenerSettings, nil] The URL shortener feature allows automatic replacement of URLs that were generat
|
|
37
39
|
#
|
|
38
40
|
# @param webhook_api_version [Symbol, Telnyx::Models::MessagingProfileCreateParams::WebhookAPIVersion] Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 201
|
|
@@ -82,7 +84,7 @@ module Telnyx
|
|
|
82
84
|
#
|
|
83
85
|
# Update a messaging profile
|
|
84
86
|
#
|
|
85
|
-
# @overload update(messaging_profile_id, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
|
|
87
|
+
# @overload update(messaging_profile_id, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
|
|
86
88
|
#
|
|
87
89
|
# @param messaging_profile_id [String] The id of the messaging profile to retrieve
|
|
88
90
|
#
|
|
@@ -104,6 +106,8 @@ module Telnyx
|
|
|
104
106
|
#
|
|
105
107
|
# @param number_pool_settings [Telnyx::Models::NumberPoolSettings, nil] Number Pool allows you to send messages from a pool of numbers of different type
|
|
106
108
|
#
|
|
109
|
+
# @param smart_encoding [Boolean] Enables automatic character encoding optimization for SMS messages. When enabled
|
|
110
|
+
#
|
|
107
111
|
# @param url_shortener_settings [Telnyx::Models::URLShortenerSettings, nil] The URL shortener feature allows automatic replacement of URLs that were generat
|
|
108
112
|
#
|
|
109
113
|
# @param v1_secret [String] Secret used to authenticate with v1 endpoints.
|
|
@@ -11,7 +11,7 @@ module Telnyx
|
|
|
11
11
|
#
|
|
12
12
|
# Submit a new tollfree verification request
|
|
13
13
|
#
|
|
14
|
-
# @overload create(additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, webhook_url: nil, request_options: {})
|
|
14
|
+
# @overload create(additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, campaign_verify_authorization_token: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, webhook_url: nil, request_options: {})
|
|
15
15
|
#
|
|
16
16
|
# @param additional_information [String] Any additional information
|
|
17
17
|
#
|
|
@@ -61,6 +61,8 @@ module Telnyx
|
|
|
61
61
|
#
|
|
62
62
|
# @param business_registration_type [String, nil] Type of business registration being provided. Required from January 2026.
|
|
63
63
|
#
|
|
64
|
+
# @param campaign_verify_authorization_token [String, nil] Campaign Verify Authorization Token required for Political use case submissions
|
|
65
|
+
#
|
|
64
66
|
# @param doing_business_as [String, nil] Doing Business As (DBA) name if different from legal name
|
|
65
67
|
#
|
|
66
68
|
# @param entity_type [Symbol, Telnyx::Models::MessagingTollfree::Verification::TollFreeVerificationEntityType, nil] Business entity classification
|
|
@@ -119,7 +121,7 @@ module Telnyx
|
|
|
119
121
|
# Update an existing tollfree verification request. This is particularly useful
|
|
120
122
|
# when there are pending customer actions to be taken.
|
|
121
123
|
#
|
|
122
|
-
# @overload update(id, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, webhook_url: nil, request_options: {})
|
|
124
|
+
# @overload update(id, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, campaign_verify_authorization_token: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, webhook_url: nil, request_options: {})
|
|
123
125
|
#
|
|
124
126
|
# @param id [String]
|
|
125
127
|
#
|
|
@@ -171,6 +173,8 @@ module Telnyx
|
|
|
171
173
|
#
|
|
172
174
|
# @param business_registration_type [String, nil] Type of business registration being provided. Required from January 2026.
|
|
173
175
|
#
|
|
176
|
+
# @param campaign_verify_authorization_token [String, nil] Campaign Verify Authorization Token required for Political use case submissions
|
|
177
|
+
#
|
|
174
178
|
# @param doing_business_as [String, nil] Doing Business As (DBA) name if different from legal name
|
|
175
179
|
#
|
|
176
180
|
# @param entity_type [Symbol, Telnyx::Models::MessagingTollfree::Verification::TollFreeVerificationEntityType, nil] Business entity classification
|
|
@@ -8,7 +8,7 @@ module Telnyx
|
|
|
8
8
|
# integration with Microsoft Teams for the current user. This will create new
|
|
9
9
|
# external connections on the user's account if needed, and/or report the
|
|
10
10
|
# integration results as
|
|
11
|
-
# [log messages](https://developers.telnyx.com/api/external-
|
|
11
|
+
# [log messages](https://developers.telnyx.com/api-reference/external-connections/list-all-log-messages#list-all-log-messages).
|
|
12
12
|
#
|
|
13
13
|
# @overload refresh(request_options: {})
|
|
14
14
|
#
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
class Organizations
|
|
6
|
+
class Users
|
|
7
|
+
class Actions
|
|
8
|
+
# Deletes a user in your organization.
|
|
9
|
+
#
|
|
10
|
+
# @overload remove(id, request_options: {})
|
|
11
|
+
#
|
|
12
|
+
# @param id [String] Organization User ID
|
|
13
|
+
#
|
|
14
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
15
|
+
#
|
|
16
|
+
# @return [Telnyx::Models::Organizations::Users::ActionRemoveResponse]
|
|
17
|
+
#
|
|
18
|
+
# @see Telnyx::Models::Organizations::Users::ActionRemoveParams
|
|
19
|
+
def remove(id, params = {})
|
|
20
|
+
@client.request(
|
|
21
|
+
method: :post,
|
|
22
|
+
path: ["organizations/users/%1$s/actions/remove", id],
|
|
23
|
+
model: Telnyx::Models::Organizations::Users::ActionRemoveResponse,
|
|
24
|
+
options: params[:request_options]
|
|
25
|
+
)
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
# @api private
|
|
29
|
+
#
|
|
30
|
+
# @param client [Telnyx::Client]
|
|
31
|
+
def initialize(client:)
|
|
32
|
+
@client = client
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|