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
|
@@ -0,0 +1,289 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Calls
|
|
6
|
+
# @see Telnyx::Resources::Calls::Actions#add_ai_assistant_messages
|
|
7
|
+
class ActionAddAIAssistantMessagesParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute client_state
|
|
12
|
+
# Use this field to add state to every subsequent webhook. It must be a valid
|
|
13
|
+
# Base-64 encoded string.
|
|
14
|
+
#
|
|
15
|
+
# @return [String, nil]
|
|
16
|
+
optional :client_state, String
|
|
17
|
+
|
|
18
|
+
# @!attribute command_id
|
|
19
|
+
# Use this field to avoid duplicate commands. Telnyx will ignore any command with
|
|
20
|
+
# the same `command_id` for the same `call_control_id`.
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :command_id, String
|
|
24
|
+
|
|
25
|
+
# @!attribute messages
|
|
26
|
+
# The messages to add to the conversation.
|
|
27
|
+
#
|
|
28
|
+
# @return [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>, nil]
|
|
29
|
+
optional :messages,
|
|
30
|
+
-> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message] }
|
|
31
|
+
|
|
32
|
+
# @!method initialize(client_state: nil, command_id: nil, messages: nil, request_options: {})
|
|
33
|
+
# Some parameter documentations has been truncated, see
|
|
34
|
+
# {Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams} for more details.
|
|
35
|
+
#
|
|
36
|
+
# @param client_state [String] Use this field to add state to every subsequent webhook. It must be a valid Base
|
|
37
|
+
#
|
|
38
|
+
# @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
|
|
39
|
+
#
|
|
40
|
+
# @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.
|
|
41
|
+
#
|
|
42
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
43
|
+
|
|
44
|
+
# Messages sent by an end user
|
|
45
|
+
module Message
|
|
46
|
+
extend Telnyx::Internal::Type::Union
|
|
47
|
+
|
|
48
|
+
discriminator :role
|
|
49
|
+
|
|
50
|
+
# Messages sent by an end user
|
|
51
|
+
variant :user, -> { Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::User }
|
|
52
|
+
|
|
53
|
+
# Messages sent by the model in response to user messages.
|
|
54
|
+
variant :assistant, -> { Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant }
|
|
55
|
+
|
|
56
|
+
variant :tool, -> { Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::Tool }
|
|
57
|
+
|
|
58
|
+
# Developer-provided instructions that the model should follow, regardless of messages sent by the user.
|
|
59
|
+
variant :system, -> { Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::System }
|
|
60
|
+
|
|
61
|
+
# Developer-provided instructions that the model should follow, regardless of messages sent by the user.
|
|
62
|
+
variant :developer, -> { Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::Developer }
|
|
63
|
+
|
|
64
|
+
class User < Telnyx::Internal::Type::BaseModel
|
|
65
|
+
# @!attribute content
|
|
66
|
+
# The contents of the user message.
|
|
67
|
+
#
|
|
68
|
+
# @return [String]
|
|
69
|
+
required :content, String
|
|
70
|
+
|
|
71
|
+
# @!attribute role
|
|
72
|
+
# The role of the messages author, in this case `user`.
|
|
73
|
+
#
|
|
74
|
+
# @return [Symbol, :user]
|
|
75
|
+
required :role, const: :user
|
|
76
|
+
|
|
77
|
+
# @!attribute metadata
|
|
78
|
+
# Metadata to add to the message
|
|
79
|
+
#
|
|
80
|
+
# @return [Object, nil]
|
|
81
|
+
optional :metadata, Telnyx::Internal::Type::Unknown
|
|
82
|
+
|
|
83
|
+
# @!method initialize(content:, metadata: nil, role: :user)
|
|
84
|
+
# Messages sent by an end user
|
|
85
|
+
#
|
|
86
|
+
# @param content [String] The contents of the user message.
|
|
87
|
+
#
|
|
88
|
+
# @param metadata [Object] Metadata to add to the message
|
|
89
|
+
#
|
|
90
|
+
# @param role [Symbol, :user] The role of the messages author, in this case `user`.
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
class Assistant < Telnyx::Internal::Type::BaseModel
|
|
94
|
+
# @!attribute role
|
|
95
|
+
# The role of the messages author, in this case `assistant`.
|
|
96
|
+
#
|
|
97
|
+
# @return [Symbol, :assistant]
|
|
98
|
+
required :role, const: :assistant
|
|
99
|
+
|
|
100
|
+
# @!attribute content
|
|
101
|
+
# The contents of the assistant message. Required unless `tool_calls`
|
|
102
|
+
#
|
|
103
|
+
# @return [String, nil]
|
|
104
|
+
optional :content, String
|
|
105
|
+
|
|
106
|
+
# @!attribute metadata
|
|
107
|
+
# Metadata to add to the message
|
|
108
|
+
#
|
|
109
|
+
# @return [Object, nil]
|
|
110
|
+
optional :metadata, Telnyx::Internal::Type::Unknown
|
|
111
|
+
|
|
112
|
+
# @!attribute tool_calls
|
|
113
|
+
# The tool calls generated by the model, such as function calls.
|
|
114
|
+
#
|
|
115
|
+
# @return [Array<Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall>, nil]
|
|
116
|
+
optional :tool_calls,
|
|
117
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall] }
|
|
118
|
+
|
|
119
|
+
# @!method initialize(content: nil, metadata: nil, tool_calls: nil, role: :assistant)
|
|
120
|
+
# Messages sent by the model in response to user messages.
|
|
121
|
+
#
|
|
122
|
+
# @param content [String] The contents of the assistant message. Required unless `tool_calls`
|
|
123
|
+
#
|
|
124
|
+
# @param metadata [Object] Metadata to add to the message
|
|
125
|
+
#
|
|
126
|
+
# @param tool_calls [Array<Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall>] The tool calls generated by the model, such as function calls.
|
|
127
|
+
#
|
|
128
|
+
# @param role [Symbol, :assistant] The role of the messages author, in this case `assistant`.
|
|
129
|
+
|
|
130
|
+
class ToolCall < Telnyx::Internal::Type::BaseModel
|
|
131
|
+
# @!attribute id
|
|
132
|
+
# The ID of the tool call.
|
|
133
|
+
#
|
|
134
|
+
# @return [String]
|
|
135
|
+
required :id, String
|
|
136
|
+
|
|
137
|
+
# @!attribute function
|
|
138
|
+
# The function that the model called.
|
|
139
|
+
#
|
|
140
|
+
# @return [Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall::Function]
|
|
141
|
+
required :function,
|
|
142
|
+
-> { Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall::Function }
|
|
143
|
+
|
|
144
|
+
# @!attribute type
|
|
145
|
+
# The type of the tool. Currently, only `function` is supported.
|
|
146
|
+
#
|
|
147
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall::Type]
|
|
148
|
+
required :type,
|
|
149
|
+
enum: -> { Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall::Type }
|
|
150
|
+
|
|
151
|
+
# @!method initialize(id:, function:, type:)
|
|
152
|
+
# A call to a function tool created by the model.
|
|
153
|
+
#
|
|
154
|
+
# @param id [String] The ID of the tool call.
|
|
155
|
+
#
|
|
156
|
+
# @param function [Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall::Function] The function that the model called.
|
|
157
|
+
#
|
|
158
|
+
# @param type [Symbol, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall::Type] The type of the tool. Currently, only `function` is supported.
|
|
159
|
+
|
|
160
|
+
# @see Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall#function
|
|
161
|
+
class Function < Telnyx::Internal::Type::BaseModel
|
|
162
|
+
# @!attribute name
|
|
163
|
+
# The name of the function to call.
|
|
164
|
+
#
|
|
165
|
+
# @return [String]
|
|
166
|
+
required :name, String
|
|
167
|
+
|
|
168
|
+
# @!method initialize(name:)
|
|
169
|
+
# The function that the model called.
|
|
170
|
+
#
|
|
171
|
+
# @param name [String] The name of the function to call.
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
# The type of the tool. Currently, only `function` is supported.
|
|
175
|
+
#
|
|
176
|
+
# @see Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall#type
|
|
177
|
+
module Type
|
|
178
|
+
extend Telnyx::Internal::Type::Enum
|
|
179
|
+
|
|
180
|
+
FUNCTION = :function
|
|
181
|
+
|
|
182
|
+
# @!method self.values
|
|
183
|
+
# @return [Array<Symbol>]
|
|
184
|
+
end
|
|
185
|
+
end
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
class Tool < Telnyx::Internal::Type::BaseModel
|
|
189
|
+
# @!attribute content
|
|
190
|
+
# The contents of the tool message.
|
|
191
|
+
#
|
|
192
|
+
# @return [String]
|
|
193
|
+
required :content, String
|
|
194
|
+
|
|
195
|
+
# @!attribute role
|
|
196
|
+
# The role of the messages author, in this case `tool`.
|
|
197
|
+
#
|
|
198
|
+
# @return [Symbol, :tool]
|
|
199
|
+
required :role, const: :tool
|
|
200
|
+
|
|
201
|
+
# @!attribute tool_call_id
|
|
202
|
+
# Tool call that this message is responding to.
|
|
203
|
+
#
|
|
204
|
+
# @return [String]
|
|
205
|
+
required :tool_call_id, String
|
|
206
|
+
|
|
207
|
+
# @!attribute metadata
|
|
208
|
+
# Metadata to add to the message
|
|
209
|
+
#
|
|
210
|
+
# @return [Object, nil]
|
|
211
|
+
optional :metadata, Telnyx::Internal::Type::Unknown
|
|
212
|
+
|
|
213
|
+
# @!method initialize(content:, tool_call_id:, metadata: nil, role: :tool)
|
|
214
|
+
# @param content [String] The contents of the tool message.
|
|
215
|
+
#
|
|
216
|
+
# @param tool_call_id [String] Tool call that this message is responding to.
|
|
217
|
+
#
|
|
218
|
+
# @param metadata [Object] Metadata to add to the message
|
|
219
|
+
#
|
|
220
|
+
# @param role [Symbol, :tool] The role of the messages author, in this case `tool`.
|
|
221
|
+
end
|
|
222
|
+
|
|
223
|
+
class System < Telnyx::Internal::Type::BaseModel
|
|
224
|
+
# @!attribute content
|
|
225
|
+
# The contents of the system message.
|
|
226
|
+
#
|
|
227
|
+
# @return [String]
|
|
228
|
+
required :content, String
|
|
229
|
+
|
|
230
|
+
# @!attribute role
|
|
231
|
+
# The role of the messages author, in this case `system`.
|
|
232
|
+
#
|
|
233
|
+
# @return [Symbol, :system]
|
|
234
|
+
required :role, const: :system
|
|
235
|
+
|
|
236
|
+
# @!attribute metadata
|
|
237
|
+
# Metadata to add to the message
|
|
238
|
+
#
|
|
239
|
+
# @return [Object, nil]
|
|
240
|
+
optional :metadata, Telnyx::Internal::Type::Unknown
|
|
241
|
+
|
|
242
|
+
# @!method initialize(content:, metadata: nil, role: :system)
|
|
243
|
+
# Developer-provided instructions that the model should follow, regardless of
|
|
244
|
+
# messages sent by the user.
|
|
245
|
+
#
|
|
246
|
+
# @param content [String] The contents of the system message.
|
|
247
|
+
#
|
|
248
|
+
# @param metadata [Object] Metadata to add to the message
|
|
249
|
+
#
|
|
250
|
+
# @param role [Symbol, :system] The role of the messages author, in this case `system`.
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
class Developer < Telnyx::Internal::Type::BaseModel
|
|
254
|
+
# @!attribute content
|
|
255
|
+
# The contents of the developer message.
|
|
256
|
+
#
|
|
257
|
+
# @return [String]
|
|
258
|
+
required :content, String
|
|
259
|
+
|
|
260
|
+
# @!attribute role
|
|
261
|
+
# The role of the messages author, in this case developer.
|
|
262
|
+
#
|
|
263
|
+
# @return [Symbol, :developer]
|
|
264
|
+
required :role, const: :developer
|
|
265
|
+
|
|
266
|
+
# @!attribute metadata
|
|
267
|
+
# Metadata to add to the message
|
|
268
|
+
#
|
|
269
|
+
# @return [Object, nil]
|
|
270
|
+
optional :metadata, Telnyx::Internal::Type::Unknown
|
|
271
|
+
|
|
272
|
+
# @!method initialize(content:, metadata: nil, role: :developer)
|
|
273
|
+
# Developer-provided instructions that the model should follow, regardless of
|
|
274
|
+
# messages sent by the user.
|
|
275
|
+
#
|
|
276
|
+
# @param content [String] The contents of the developer message.
|
|
277
|
+
#
|
|
278
|
+
# @param metadata [Object] Metadata to add to the message
|
|
279
|
+
#
|
|
280
|
+
# @param role [Symbol, :developer] The role of the messages author, in this case developer.
|
|
281
|
+
end
|
|
282
|
+
|
|
283
|
+
# @!method self.variants
|
|
284
|
+
# @return [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)]
|
|
285
|
+
end
|
|
286
|
+
end
|
|
287
|
+
end
|
|
288
|
+
end
|
|
289
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Calls
|
|
6
|
+
# @see Telnyx::Resources::Calls::Actions#add_ai_assistant_messages
|
|
7
|
+
class ActionAddAIAssistantMessagesResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Telnyx::Models::Calls::CallControlCommandResult, nil]
|
|
11
|
+
optional :data, -> { Telnyx::Calls::CallControlCommandResult }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data: nil)
|
|
14
|
+
# @param data [Telnyx::Models::Calls::CallControlCommandResult]
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -29,8 +29,9 @@ module Telnyx
|
|
|
29
29
|
optional :direction, enum: -> { Telnyx::Calls::ActionStartNoiseSuppressionParams::Direction }
|
|
30
30
|
|
|
31
31
|
# @!attribute noise_suppression_engine
|
|
32
|
-
# The engine to use for noise suppression. For backward compatibility, engines A
|
|
33
|
-
# and
|
|
32
|
+
# The engine to use for noise suppression. For backward compatibility, engines A,
|
|
33
|
+
# B, and C are also supported, but are deprecated: A - Denoiser B - DeepFilterNet
|
|
34
|
+
# C - Krisp
|
|
34
35
|
#
|
|
35
36
|
# @return [Symbol, Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngine, nil]
|
|
36
37
|
optional :noise_suppression_engine,
|
|
@@ -71,13 +72,15 @@ module Telnyx
|
|
|
71
72
|
# @return [Array<Symbol>]
|
|
72
73
|
end
|
|
73
74
|
|
|
74
|
-
# The engine to use for noise suppression. For backward compatibility, engines A
|
|
75
|
-
# and
|
|
75
|
+
# The engine to use for noise suppression. For backward compatibility, engines A,
|
|
76
|
+
# B, and C are also supported, but are deprecated: A - Denoiser B - DeepFilterNet
|
|
77
|
+
# C - Krisp
|
|
76
78
|
module NoiseSuppressionEngine
|
|
77
79
|
extend Telnyx::Internal::Type::Enum
|
|
78
80
|
|
|
79
81
|
DENOISER = :Denoiser
|
|
80
82
|
DEEP_FILTER_NET = :DeepFilterNet
|
|
83
|
+
KRISP = :Krisp
|
|
81
84
|
|
|
82
85
|
# @!method self.values
|
|
83
86
|
# @return [Array<Symbol>]
|
|
@@ -24,13 +24,23 @@ module Telnyx
|
|
|
24
24
|
# @return [Telnyx::Models::ConferenceListParams::Page, nil]
|
|
25
25
|
optional :page, -> { Telnyx::ConferenceListParams::Page }
|
|
26
26
|
|
|
27
|
+
# @!attribute page_number
|
|
28
|
+
#
|
|
29
|
+
# @return [Integer, nil]
|
|
30
|
+
optional :page_number, Integer
|
|
31
|
+
|
|
32
|
+
# @!attribute page_size
|
|
33
|
+
#
|
|
34
|
+
# @return [Integer, nil]
|
|
35
|
+
optional :page_size, Integer
|
|
36
|
+
|
|
27
37
|
# @!attribute region
|
|
28
38
|
# Region where the conference data is located
|
|
29
39
|
#
|
|
30
40
|
# @return [Symbol, Telnyx::Models::ConferenceListParams::Region, nil]
|
|
31
41
|
optional :region, enum: -> { Telnyx::ConferenceListParams::Region }
|
|
32
42
|
|
|
33
|
-
# @!method initialize(filter: nil, page: nil, region: nil, request_options: {})
|
|
43
|
+
# @!method initialize(filter: nil, page: nil, page_number: nil, page_size: nil, region: nil, request_options: {})
|
|
34
44
|
# Some parameter documentations has been truncated, see
|
|
35
45
|
# {Telnyx::Models::ConferenceListParams} for more details.
|
|
36
46
|
#
|
|
@@ -38,6 +48,10 @@ module Telnyx
|
|
|
38
48
|
#
|
|
39
49
|
# @param page [Telnyx::Models::ConferenceListParams::Page] Consolidated page parameter (deepObject style). Originally: page[after], page[be
|
|
40
50
|
#
|
|
51
|
+
# @param page_number [Integer]
|
|
52
|
+
#
|
|
53
|
+
# @param page_size [Integer]
|
|
54
|
+
#
|
|
41
55
|
# @param region [Symbol, Telnyx::Models::ConferenceListParams::Region] Region where the conference data is located
|
|
42
56
|
#
|
|
43
57
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -286,19 +300,7 @@ module Telnyx
|
|
|
286
300
|
# @return [Integer, nil]
|
|
287
301
|
optional :limit, Integer
|
|
288
302
|
|
|
289
|
-
# @!
|
|
290
|
-
# The page number to load
|
|
291
|
-
#
|
|
292
|
-
# @return [Integer, nil]
|
|
293
|
-
optional :number, Integer
|
|
294
|
-
|
|
295
|
-
# @!attribute size
|
|
296
|
-
# The size of the page
|
|
297
|
-
#
|
|
298
|
-
# @return [Integer, nil]
|
|
299
|
-
optional :size, Integer
|
|
300
|
-
|
|
301
|
-
# @!method initialize(after: nil, before: nil, limit: nil, number: nil, size: nil)
|
|
303
|
+
# @!method initialize(after: nil, before: nil, limit: nil)
|
|
302
304
|
# Consolidated page parameter (deepObject style). Originally: page[after],
|
|
303
305
|
# page[before], page[limit], page[size], page[number]
|
|
304
306
|
#
|
|
@@ -307,10 +309,6 @@ module Telnyx
|
|
|
307
309
|
# @param before [String] Opaque identifier of previous page
|
|
308
310
|
#
|
|
309
311
|
# @param limit [Integer] Limit of records per single page
|
|
310
|
-
#
|
|
311
|
-
# @param number [Integer] The page number to load
|
|
312
|
-
#
|
|
313
|
-
# @param size [Integer] The size of the page
|
|
314
312
|
end
|
|
315
313
|
|
|
316
314
|
# Region where the conference data is located
|
|
@@ -21,13 +21,23 @@ module Telnyx
|
|
|
21
21
|
# @return [Telnyx::Models::ConferenceListParticipantsParams::Page, nil]
|
|
22
22
|
optional :page, -> { Telnyx::ConferenceListParticipantsParams::Page }
|
|
23
23
|
|
|
24
|
+
# @!attribute page_number
|
|
25
|
+
#
|
|
26
|
+
# @return [Integer, nil]
|
|
27
|
+
optional :page_number, Integer
|
|
28
|
+
|
|
29
|
+
# @!attribute page_size
|
|
30
|
+
#
|
|
31
|
+
# @return [Integer, nil]
|
|
32
|
+
optional :page_size, Integer
|
|
33
|
+
|
|
24
34
|
# @!attribute region
|
|
25
35
|
# Region where the conference data is located
|
|
26
36
|
#
|
|
27
37
|
# @return [Symbol, Telnyx::Models::ConferenceListParticipantsParams::Region, nil]
|
|
28
38
|
optional :region, enum: -> { Telnyx::ConferenceListParticipantsParams::Region }
|
|
29
39
|
|
|
30
|
-
# @!method initialize(filter: nil, page: nil, region: nil, request_options: {})
|
|
40
|
+
# @!method initialize(filter: nil, page: nil, page_number: nil, page_size: nil, region: nil, request_options: {})
|
|
31
41
|
# Some parameter documentations has been truncated, see
|
|
32
42
|
# {Telnyx::Models::ConferenceListParticipantsParams} for more details.
|
|
33
43
|
#
|
|
@@ -35,6 +45,10 @@ module Telnyx
|
|
|
35
45
|
#
|
|
36
46
|
# @param page [Telnyx::Models::ConferenceListParticipantsParams::Page] Consolidated page parameter (deepObject style). Originally: page[after], page[be
|
|
37
47
|
#
|
|
48
|
+
# @param page_number [Integer]
|
|
49
|
+
#
|
|
50
|
+
# @param page_size [Integer]
|
|
51
|
+
#
|
|
38
52
|
# @param region [Symbol, Telnyx::Models::ConferenceListParticipantsParams::Region] Region where the conference data is located
|
|
39
53
|
#
|
|
40
54
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -91,19 +105,7 @@ module Telnyx
|
|
|
91
105
|
# @return [Integer, nil]
|
|
92
106
|
optional :limit, Integer
|
|
93
107
|
|
|
94
|
-
# @!
|
|
95
|
-
# The page number to load
|
|
96
|
-
#
|
|
97
|
-
# @return [Integer, nil]
|
|
98
|
-
optional :number, Integer
|
|
99
|
-
|
|
100
|
-
# @!attribute size
|
|
101
|
-
# The size of the page
|
|
102
|
-
#
|
|
103
|
-
# @return [Integer, nil]
|
|
104
|
-
optional :size, Integer
|
|
105
|
-
|
|
106
|
-
# @!method initialize(after: nil, before: nil, limit: nil, number: nil, size: nil)
|
|
108
|
+
# @!method initialize(after: nil, before: nil, limit: nil)
|
|
107
109
|
# Consolidated page parameter (deepObject style). Originally: page[after],
|
|
108
110
|
# page[before], page[limit], page[size], page[number]
|
|
109
111
|
#
|
|
@@ -112,10 +114,6 @@ module Telnyx
|
|
|
112
114
|
# @param before [String] Opaque identifier of previous page
|
|
113
115
|
#
|
|
114
116
|
# @param limit [Integer] Limit of records per single page
|
|
115
|
-
#
|
|
116
|
-
# @param number [Integer] The page number to load
|
|
117
|
-
#
|
|
118
|
-
# @param size [Integer] The size of the page
|
|
119
117
|
end
|
|
120
118
|
|
|
121
119
|
# Region where the conference data is located
|
|
@@ -14,12 +14,26 @@ module Telnyx
|
|
|
14
14
|
# @return [Telnyx::Models::ConnectionListActiveCallsParams::Page, nil]
|
|
15
15
|
optional :page, -> { Telnyx::ConnectionListActiveCallsParams::Page }
|
|
16
16
|
|
|
17
|
-
# @!
|
|
17
|
+
# @!attribute page_number
|
|
18
|
+
#
|
|
19
|
+
# @return [Integer, nil]
|
|
20
|
+
optional :page_number, Integer
|
|
21
|
+
|
|
22
|
+
# @!attribute page_size
|
|
23
|
+
#
|
|
24
|
+
# @return [Integer, nil]
|
|
25
|
+
optional :page_size, Integer
|
|
26
|
+
|
|
27
|
+
# @!method initialize(page: nil, page_number: nil, page_size: nil, request_options: {})
|
|
18
28
|
# Some parameter documentations has been truncated, see
|
|
19
29
|
# {Telnyx::Models::ConnectionListActiveCallsParams} for more details.
|
|
20
30
|
#
|
|
21
31
|
# @param page [Telnyx::Models::ConnectionListActiveCallsParams::Page] Consolidated page parameter (deepObject style). Originally: page[after], page[be
|
|
22
32
|
#
|
|
33
|
+
# @param page_number [Integer]
|
|
34
|
+
#
|
|
35
|
+
# @param page_size [Integer]
|
|
36
|
+
#
|
|
23
37
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
24
38
|
|
|
25
39
|
class Page < Telnyx::Internal::Type::BaseModel
|
|
@@ -41,19 +55,7 @@ module Telnyx
|
|
|
41
55
|
# @return [Integer, nil]
|
|
42
56
|
optional :limit, Integer
|
|
43
57
|
|
|
44
|
-
# @!
|
|
45
|
-
# The page number to load
|
|
46
|
-
#
|
|
47
|
-
# @return [Integer, nil]
|
|
48
|
-
optional :number, Integer
|
|
49
|
-
|
|
50
|
-
# @!attribute size
|
|
51
|
-
# The size of the page
|
|
52
|
-
#
|
|
53
|
-
# @return [Integer, nil]
|
|
54
|
-
optional :size, Integer
|
|
55
|
-
|
|
56
|
-
# @!method initialize(after: nil, before: nil, limit: nil, number: nil, size: nil)
|
|
58
|
+
# @!method initialize(after: nil, before: nil, limit: nil)
|
|
57
59
|
# Consolidated page parameter (deepObject style). Originally: page[after],
|
|
58
60
|
# page[before], page[limit], page[size], page[number]
|
|
59
61
|
#
|
|
@@ -62,10 +64,6 @@ module Telnyx
|
|
|
62
64
|
# @param before [String] Opaque identifier of previous page
|
|
63
65
|
#
|
|
64
66
|
# @param limit [Integer] Limit of records per single page
|
|
65
|
-
#
|
|
66
|
-
# @param number [Integer] The page number to load
|
|
67
|
-
#
|
|
68
|
-
# @param size [Integer] The size of the page
|
|
69
67
|
end
|
|
70
68
|
end
|
|
71
69
|
end
|
|
@@ -25,6 +25,13 @@ module Telnyx
|
|
|
25
25
|
# @return [String]
|
|
26
26
|
required :to, String
|
|
27
27
|
|
|
28
|
+
# @!attribute black_threshold
|
|
29
|
+
# The black threshold percentage for monochrome faxes. Only applicable if
|
|
30
|
+
# `monochrome` is set to `true`.
|
|
31
|
+
#
|
|
32
|
+
# @return [Integer, nil]
|
|
33
|
+
optional :black_threshold, Integer
|
|
34
|
+
|
|
28
35
|
# @!attribute client_state
|
|
29
36
|
# Use this field to add state to every subsequent webhook. It must be a valid
|
|
30
37
|
# Base-64 encoded string.
|
|
@@ -103,7 +110,7 @@ module Telnyx
|
|
|
103
110
|
# @return [String, nil]
|
|
104
111
|
optional :webhook_url, String
|
|
105
112
|
|
|
106
|
-
# @!method initialize(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: {})
|
|
113
|
+
# @!method initialize(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: {})
|
|
107
114
|
# Some parameter documentations has been truncated, see
|
|
108
115
|
# {Telnyx::Models::FaxCreateParams} for more details.
|
|
109
116
|
#
|
|
@@ -113,6 +120,8 @@ module Telnyx
|
|
|
113
120
|
#
|
|
114
121
|
# @param to [String] The phone number, in E.164 format, the fax will be sent to or SIP URI
|
|
115
122
|
#
|
|
123
|
+
# @param black_threshold [Integer] The black threshold percentage for monochrome faxes. Only applicable if `monochr
|
|
124
|
+
#
|
|
116
125
|
# @param client_state [String] Use this field to add state to every subsequent webhook. It must be a valid Base
|
|
117
126
|
#
|
|
118
127
|
# @param from_display_name [String] The `from_display_name` string to be used as the caller id name (SIP From Displa
|
|
@@ -8,15 +8,7 @@ module Telnyx
|
|
|
8
8
|
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Telnyx::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
-
# @!
|
|
12
|
-
# Filter by Brand ID for easier lookup in portal applications
|
|
13
|
-
#
|
|
14
|
-
# @return [String, nil]
|
|
15
|
-
optional :brand_id, String
|
|
16
|
-
|
|
17
|
-
# @!method initialize(brand_id: nil, request_options: {})
|
|
18
|
-
# @param brand_id [String] Filter by Brand ID for easier lookup in portal applications
|
|
19
|
-
#
|
|
11
|
+
# @!method initialize(request_options: {})
|
|
20
12
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
21
13
|
end
|
|
22
14
|
end
|
|
@@ -83,6 +83,14 @@ module Telnyx
|
|
|
83
83
|
# @return [Integer, nil]
|
|
84
84
|
optional :redaction_level, Integer
|
|
85
85
|
|
|
86
|
+
# @!attribute smart_encoding
|
|
87
|
+
# Enables automatic character encoding optimization for SMS messages. When
|
|
88
|
+
# enabled, the system automatically selects the most efficient encoding (GSM-7 or
|
|
89
|
+
# UCS-2) based on message content to maximize character limits and minimize costs.
|
|
90
|
+
#
|
|
91
|
+
# @return [Boolean, nil]
|
|
92
|
+
optional :smart_encoding, Telnyx::Internal::Type::Boolean
|
|
93
|
+
|
|
86
94
|
# @!attribute url_shortener_settings
|
|
87
95
|
# The URL shortener feature allows automatic replacement of URLs that were
|
|
88
96
|
# generated using a public URL shortener service. Some examples include bit.do,
|
|
@@ -155,7 +163,7 @@ module Telnyx
|
|
|
155
163
|
optional :updated_at, Time
|
|
156
164
|
end
|
|
157
165
|
|
|
158
|
-
# @!method initialize(id: nil, alpha_sender: nil, created_at: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, record_type: nil, redaction_enabled: nil, redaction_level: nil, updated_at: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil)
|
|
166
|
+
# @!method initialize(id: nil, alpha_sender: nil, created_at: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, record_type: nil, redaction_enabled: nil, redaction_level: nil, smart_encoding: nil, updated_at: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil)
|
|
159
167
|
# Some parameter documentations has been truncated, see
|
|
160
168
|
# {Telnyx::Models::MessagingProfile} for more details.
|
|
161
169
|
#
|
|
@@ -189,6 +197,8 @@ module Telnyx
|
|
|
189
197
|
#
|
|
190
198
|
# @param redaction_level [Integer] Determines how much information is redacted in messages for privacy or complianc
|
|
191
199
|
#
|
|
200
|
+
# @param smart_encoding [Boolean] Enables automatic character encoding optimization for SMS messages. When enabled
|
|
201
|
+
#
|
|
192
202
|
# @param updated_at [Time] ISO 8601 formatted date indicating when the resource was updated.
|
|
193
203
|
#
|
|
194
204
|
# @param url_shortener_settings [Telnyx::Models::URLShortenerSettings, nil] The URL shortener feature allows automatic replacement of URLs that were generat
|
|
@@ -75,6 +75,14 @@ module Telnyx
|
|
|
75
75
|
# @return [Telnyx::Models::NumberPoolSettings, nil]
|
|
76
76
|
optional :number_pool_settings, -> { Telnyx::NumberPoolSettings }, nil?: true
|
|
77
77
|
|
|
78
|
+
# @!attribute smart_encoding
|
|
79
|
+
# Enables automatic character encoding optimization for SMS messages. When
|
|
80
|
+
# enabled, the system automatically selects the most efficient encoding (GSM-7 or
|
|
81
|
+
# UCS-2) based on message content to maximize character limits and minimize costs.
|
|
82
|
+
#
|
|
83
|
+
# @return [Boolean, nil]
|
|
84
|
+
optional :smart_encoding, Telnyx::Internal::Type::Boolean
|
|
85
|
+
|
|
78
86
|
# @!attribute url_shortener_settings
|
|
79
87
|
# The URL shortener feature allows automatic replacement of URLs that were
|
|
80
88
|
# generated using a public URL shortener service. Some examples include bit.do,
|
|
@@ -107,7 +115,7 @@ module Telnyx
|
|
|
107
115
|
# @return [String, nil]
|
|
108
116
|
optional :webhook_url, String, nil?: true
|
|
109
117
|
|
|
110
|
-
# @!method initialize(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: {})
|
|
118
|
+
# @!method initialize(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: {})
|
|
111
119
|
# Some parameter documentations has been truncated, see
|
|
112
120
|
# {Telnyx::Models::MessagingProfileCreateParams} for more details.
|
|
113
121
|
#
|
|
@@ -131,6 +139,8 @@ module Telnyx
|
|
|
131
139
|
#
|
|
132
140
|
# @param number_pool_settings [Telnyx::Models::NumberPoolSettings, nil] Number Pool allows you to send messages from a pool of numbers of different type
|
|
133
141
|
#
|
|
142
|
+
# @param smart_encoding [Boolean] Enables automatic character encoding optimization for SMS messages. When enabled
|
|
143
|
+
#
|
|
134
144
|
# @param url_shortener_settings [Telnyx::Models::URLShortenerSettings, nil] The URL shortener feature allows automatic replacement of URLs that were generat
|
|
135
145
|
#
|
|
136
146
|
# @param webhook_api_version [Symbol, Telnyx::Models::MessagingProfileCreateParams::WebhookAPIVersion] Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 201
|