telnyx 5.69.0 → 5.71.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 +50 -0
- data/README.md +1 -1
- data/lib/telnyx/internal/util.rb +3 -1
- data/lib/telnyx/models/ai/assistant.rb +6 -149
- data/lib/telnyx/models/ai/assistant_create_params.rb +3 -42
- data/lib/telnyx/models/ai/assistant_update_params.rb +3 -42
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +3 -43
- data/lib/telnyx/models/ai/conversation_add_message_params.rb +4 -4
- data/lib/telnyx/models/ai/inference_embedding.rb +3 -43
- data/lib/telnyx/models/ai/observability.rb +46 -0
- data/lib/telnyx/models/ai/observability_req.rb +46 -0
- data/lib/telnyx/models/book_appointment_tool.rb +31 -0
- data/lib/telnyx/models/book_appointment_tool_params.rb +51 -0
- data/lib/telnyx/models/call_assistant_request.rb +176 -0
- data/lib/telnyx/models/call_control_bucket_ids.rb +23 -0
- data/lib/telnyx/models/call_control_retrieval_tool.rb +31 -0
- data/lib/telnyx/models/call_dial_params.rb +34 -1
- data/lib/telnyx/models/calls/action_answer_params.rb +11 -1
- data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +6 -39
- data/lib/telnyx/models/calls/action_transfer_params.rb +24 -1
- data/lib/telnyx/models/check_availability_tool.rb +31 -0
- data/lib/telnyx/models/check_availability_tool_params.rb +31 -0
- data/lib/telnyx/models/enterprise_create_params.rb +1 -1
- data/lib/telnyx/models/enterprise_public.rb +1 -1
- data/lib/telnyx/models/enterprise_update_params.rb +1 -1
- data/lib/telnyx/models/enterprises/reputation/{number_create_params.rb → number_associate_params.rb} +2 -2
- data/lib/telnyx/models/enterprises/reputation/{number_create_response.rb → number_associate_response.rb} +5 -5
- data/lib/telnyx/models/enterprises/reputation/{number_delete_params.rb → number_disassociate_params.rb} +2 -2
- data/lib/telnyx/models/enterprises/{reputation_list_params.rb → reputation_disable_params.rb} +2 -2
- data/lib/telnyx/models/enterprises/{reputation_create_params.rb → reputation_enable_params.rb} +6 -6
- data/lib/telnyx/models/enterprises/{reputation_create_response.rb → reputation_enable_response.rb} +2 -2
- data/lib/telnyx/models/enterprises/{reputation_delete_all_params.rb → reputation_retrieve_params.rb} +2 -2
- data/lib/telnyx/models/enterprises/{reputation_list_response.rb → reputation_retrieve_response.rb} +2 -2
- data/lib/telnyx/models/porting_orders/phone_number_block_list_params.rb +9 -9
- data/lib/telnyx/models/pronunciation_dict_alias_item.rb +51 -0
- data/lib/telnyx/models/pronunciation_dict_create_params.rb +5 -93
- data/lib/telnyx/models/pronunciation_dict_create_response.rb +3 -191
- data/lib/telnyx/models/pronunciation_dict_data.rb +101 -0
- data/lib/telnyx/models/pronunciation_dict_phoneme_item.rb +71 -0
- data/lib/telnyx/models/pronunciation_dict_retrieve_response.rb +3 -191
- data/lib/telnyx/models/pronunciation_dict_update_params.rb +5 -93
- data/lib/telnyx/models/pronunciation_dict_update_response.rb +3 -191
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +203 -191
- data/lib/telnyx/models/voice_clone_create_from_design_params.rb +3 -3
- data/lib/telnyx/models/voice_clone_create_from_upload_params.rb +371 -71
- data/lib/telnyx/models/voice_clone_create_params.rb +161 -51
- data/lib/telnyx/models/voice_clone_data.rb +51 -4
- data/lib/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_params.rb +26 -0
- data/lib/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_response.rb +54 -0
- data/lib/telnyx/models.rb +20 -0
- data/lib/telnyx/resources/ai/assistants/versions.rb +1 -1
- data/lib/telnyx/resources/ai/assistants.rb +2 -2
- data/lib/telnyx/resources/calls/actions.rb +7 -3
- data/lib/telnyx/resources/calls.rb +5 -1
- data/lib/telnyx/resources/enterprises/reputation/numbers.rb +42 -42
- data/lib/telnyx/resources/enterprises/reputation.rb +61 -61
- data/lib/telnyx/resources/pronunciation_dicts.rb +4 -4
- data/lib/telnyx/resources/texml/accounts/calls.rb +3 -3
- data/lib/telnyx/resources/voice_clones.rb +7 -27
- data/lib/telnyx/resources/whatsapp/phone_numbers/profile/photo.rb +20 -0
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +22 -9
- data/rbi/telnyx/models/ai/assistant.rbi +15 -329
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +4 -121
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +4 -121
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +4 -123
- data/rbi/telnyx/models/ai/conversation_add_message_params.rbi +5 -5
- data/rbi/telnyx/models/ai/inference_embedding.rbi +4 -123
- data/rbi/telnyx/models/ai/observability.rbi +90 -0
- data/rbi/telnyx/models/ai/observability_req.rbi +92 -0
- data/rbi/telnyx/models/book_appointment_tool.rbi +65 -0
- data/rbi/telnyx/models/book_appointment_tool_params.rbi +83 -0
- data/rbi/telnyx/models/call_assistant_request.rbi +322 -0
- data/rbi/telnyx/models/call_control_bucket_ids.rbi +42 -0
- data/rbi/telnyx/models/call_control_retrieval_tool.rbi +63 -0
- data/rbi/telnyx/models/call_dial_params.rbi +52 -0
- data/rbi/telnyx/models/calls/action_answer_params.rbi +15 -0
- data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +10 -77
- data/rbi/telnyx/models/calls/action_transfer_params.rbi +57 -0
- data/rbi/telnyx/models/check_availability_tool.rbi +67 -0
- data/rbi/telnyx/models/check_availability_tool_params.rbi +45 -0
- data/rbi/telnyx/models/enterprise_create_params.rbi +1 -1
- data/rbi/telnyx/models/enterprise_public.rbi +1 -1
- data/rbi/telnyx/models/enterprise_update_params.rbi +1 -1
- data/rbi/telnyx/models/enterprises/reputation/{number_create_params.rbi → number_associate_params.rbi} +2 -2
- data/rbi/telnyx/models/enterprises/reputation/{number_create_response.rbi → number_associate_response.rbi} +7 -7
- data/rbi/telnyx/models/enterprises/reputation/{number_delete_params.rbi → number_disassociate_params.rbi} +2 -2
- data/rbi/telnyx/models/enterprises/{reputation_list_params.rbi → reputation_disable_params.rbi} +2 -2
- data/rbi/telnyx/models/enterprises/{reputation_create_params.rbi → reputation_enable_params.rbi} +14 -14
- data/rbi/telnyx/models/enterprises/{reputation_create_response.rbi → reputation_enable_response.rbi} +2 -2
- data/rbi/telnyx/models/enterprises/{reputation_delete_all_params.rbi → reputation_retrieve_params.rbi} +2 -2
- data/rbi/telnyx/models/enterprises/{reputation_list_response.rbi → reputation_retrieve_response.rbi} +2 -2
- data/rbi/telnyx/models/porting_orders/phone_number_block_list_params.rbi +34 -34
- data/rbi/telnyx/models/pronunciation_dict_alias_item.rbi +79 -0
- data/rbi/telnyx/models/pronunciation_dict_create_params.rbi +8 -154
- data/rbi/telnyx/models/pronunciation_dict_create_response.rbi +6 -366
- data/rbi/telnyx/models/pronunciation_dict_data.rbi +186 -0
- data/rbi/telnyx/models/pronunciation_dict_phoneme_item.rbi +117 -0
- data/rbi/telnyx/models/pronunciation_dict_retrieve_response.rbi +6 -366
- data/rbi/telnyx/models/pronunciation_dict_update_params.rbi +10 -156
- data/rbi/telnyx/models/pronunciation_dict_update_response.rbi +6 -366
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +391 -403
- data/rbi/telnyx/models/voice_clone_create_from_design_params.rbi +10 -10
- data/rbi/telnyx/models/voice_clone_create_from_upload_params.rbi +711 -134
- data/rbi/telnyx/models/voice_clone_create_params.rbi +345 -79
- data/rbi/telnyx/models/voice_clone_data.rbi +77 -4
- data/rbi/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_params.rbi +47 -0
- data/rbi/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_response.rbi +118 -0
- data/rbi/telnyx/models.rbi +20 -0
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +1 -2
- data/rbi/telnyx/resources/ai/assistants.rbi +2 -4
- data/rbi/telnyx/resources/calls/actions.rbi +14 -3
- data/rbi/telnyx/resources/calls.rbi +10 -0
- data/rbi/telnyx/resources/enterprises/reputation/numbers.rbi +34 -34
- data/rbi/telnyx/resources/enterprises/reputation.rbi +44 -44
- data/rbi/telnyx/resources/pronunciation_dicts.rbi +5 -7
- data/rbi/telnyx/resources/texml/accounts/calls.rbi +5 -5
- data/rbi/telnyx/resources/voice_clones.rbi +17 -41
- data/rbi/telnyx/resources/whatsapp/phone_numbers/profile/photo.rbi +16 -0
- data/sig/telnyx/models/ai/assistant.rbs +3 -142
- data/sig/telnyx/models/ai/assistant_create_params.rbs +6 -59
- data/sig/telnyx/models/ai/assistant_update_params.rbs +6 -59
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +6 -59
- data/sig/telnyx/models/ai/conversation_add_message_params.rbs +5 -5
- data/sig/telnyx/models/ai/inference_embedding.rbs +6 -59
- data/sig/telnyx/models/ai/observability.rbs +58 -0
- data/sig/telnyx/models/ai/observability_req.rbs +58 -0
- data/sig/telnyx/models/book_appointment_tool.rbs +35 -0
- data/sig/telnyx/models/book_appointment_tool_params.rbs +39 -0
- data/sig/telnyx/models/call_assistant_request.rbs +132 -0
- data/sig/telnyx/models/call_control_bucket_ids.rbs +21 -0
- data/sig/telnyx/models/call_control_retrieval_tool.rbs +35 -0
- data/sig/telnyx/models/call_dial_params.rbs +29 -0
- data/sig/telnyx/models/calls/action_answer_params.rbs +9 -0
- data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +6 -35
- data/sig/telnyx/models/calls/action_transfer_params.rbs +20 -0
- data/sig/telnyx/models/check_availability_tool.rbs +35 -0
- data/sig/telnyx/models/check_availability_tool_params.rbs +16 -0
- data/sig/telnyx/models/enterprise_create_params.rbs +1 -1
- data/sig/telnyx/models/enterprise_public.rbs +1 -1
- data/sig/telnyx/models/enterprise_update_params.rbs +1 -1
- data/sig/telnyx/models/enterprises/reputation/{number_create_params.rbs → number_associate_params.rbs} +2 -2
- data/sig/telnyx/models/enterprises/reputation/{number_create_response.rbs → number_associate_response.rbs} +8 -8
- data/sig/telnyx/models/enterprises/reputation/{number_delete_params.rbs → number_disassociate_params.rbs} +2 -2
- data/sig/telnyx/models/enterprises/{reputation_list_params.rbs → reputation_disable_params.rbs} +2 -2
- data/sig/telnyx/models/enterprises/{reputation_create_params.rbs → reputation_enable_params.rbs} +9 -9
- data/sig/telnyx/models/enterprises/{reputation_create_response.rbs → reputation_enable_response.rbs} +2 -2
- data/sig/telnyx/models/enterprises/{reputation_delete_all_params.rbs → reputation_retrieve_params.rbs} +2 -2
- data/sig/telnyx/models/enterprises/{reputation_list_response.rbs → reputation_retrieve_response.rbs} +2 -2
- data/sig/telnyx/models/porting_orders/phone_number_block_list_params.rbs +9 -9
- data/sig/telnyx/models/pronunciation_dict_alias_item.rbs +40 -0
- data/sig/telnyx/models/pronunciation_dict_create_params.rbs +2 -58
- data/sig/telnyx/models/pronunciation_dict_create_response.rbs +6 -155
- data/sig/telnyx/models/pronunciation_dict_data.rbs +88 -0
- data/sig/telnyx/models/pronunciation_dict_phoneme_item.rbs +55 -0
- data/sig/telnyx/models/pronunciation_dict_retrieve_response.rbs +6 -155
- data/sig/telnyx/models/pronunciation_dict_update_params.rbs +2 -58
- data/sig/telnyx/models/pronunciation_dict_update_response.rbs +6 -155
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +317 -325
- data/sig/telnyx/models/voice_clone_create_from_design_params.rbs +7 -7
- data/sig/telnyx/models/voice_clone_create_from_upload_params.rbs +269 -56
- data/sig/telnyx/models/voice_clone_create_params.rbs +129 -44
- data/sig/telnyx/models/voice_clone_data.rbs +43 -0
- data/sig/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_params.rbs +30 -0
- data/sig/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_response.rbs +63 -0
- data/sig/telnyx/models.rbs +20 -0
- data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -1
- data/sig/telnyx/resources/ai/assistants.rbs +2 -2
- data/sig/telnyx/resources/calls/actions.rbs +3 -1
- data/sig/telnyx/resources/calls.rbs +2 -0
- data/sig/telnyx/resources/enterprises/reputation/numbers.rbs +7 -7
- data/sig/telnyx/resources/enterprises/reputation.rbs +8 -8
- data/sig/telnyx/resources/pronunciation_dicts.rbs +1 -1
- data/sig/telnyx/resources/texml/accounts/calls.rbs +1 -1
- data/sig/telnyx/resources/voice_clones.rbs +2 -12
- data/sig/telnyx/resources/whatsapp/phone_numbers/profile/photo.rbs +5 -0
- metadata +68 -29
- data/lib/telnyx/models/pronunciation_dict_list_response.rb +0 -190
- data/rbi/telnyx/models/pronunciation_dict_list_response.rbi +0 -353
- data/sig/telnyx/models/pronunciation_dict_list_response.rbs +0 -144
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class BookAppointmentTool < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute book_appointment
|
|
7
|
+
#
|
|
8
|
+
# @return [Telnyx::Models::BookAppointmentToolParams]
|
|
9
|
+
required :book_appointment, -> { Telnyx::BookAppointmentToolParams }
|
|
10
|
+
|
|
11
|
+
# @!attribute type
|
|
12
|
+
#
|
|
13
|
+
# @return [Symbol, Telnyx::Models::BookAppointmentTool::Type]
|
|
14
|
+
required :type, enum: -> { Telnyx::BookAppointmentTool::Type }
|
|
15
|
+
|
|
16
|
+
# @!method initialize(book_appointment:, type:)
|
|
17
|
+
# @param book_appointment [Telnyx::Models::BookAppointmentToolParams]
|
|
18
|
+
# @param type [Symbol, Telnyx::Models::BookAppointmentTool::Type]
|
|
19
|
+
|
|
20
|
+
# @see Telnyx::Models::BookAppointmentTool#type
|
|
21
|
+
module Type
|
|
22
|
+
extend Telnyx::Internal::Type::Enum
|
|
23
|
+
|
|
24
|
+
BOOK_APPOINTMENT = :book_appointment
|
|
25
|
+
|
|
26
|
+
# @!method self.values
|
|
27
|
+
# @return [Array<Symbol>]
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class BookAppointmentToolParams < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute api_key_ref
|
|
7
|
+
# Reference to an integration secret that contains your Cal.com API key. You would
|
|
8
|
+
# pass the `identifier` for an integration secret
|
|
9
|
+
# [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
10
|
+
# that refers to your Cal.com API key.
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :api_key_ref, String
|
|
14
|
+
|
|
15
|
+
# @!attribute event_type_id
|
|
16
|
+
# Event Type ID for which slots are being fetched.
|
|
17
|
+
# [cal.com](https://cal.com/docs/api-reference/v2/bookings/create-a-booking#body-event-type-id)
|
|
18
|
+
#
|
|
19
|
+
# @return [Integer]
|
|
20
|
+
required :event_type_id, Integer
|
|
21
|
+
|
|
22
|
+
# @!attribute attendee_name
|
|
23
|
+
# The name of the attendee
|
|
24
|
+
# [cal.com](https://cal.com/docs/api-reference/v2/bookings/create-a-booking#body-attendee-name).
|
|
25
|
+
# If not provided, the assistant will ask for the attendee's name.
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
optional :attendee_name, String
|
|
29
|
+
|
|
30
|
+
# @!attribute attendee_timezone
|
|
31
|
+
# The timezone of the attendee
|
|
32
|
+
# [cal.com](https://cal.com/docs/api-reference/v2/bookings/create-a-booking#body-attendee-timezone).
|
|
33
|
+
# If not provided, the assistant will ask for the attendee's timezone.
|
|
34
|
+
#
|
|
35
|
+
# @return [String, nil]
|
|
36
|
+
optional :attendee_timezone, String
|
|
37
|
+
|
|
38
|
+
# @!method initialize(api_key_ref:, event_type_id:, attendee_name: nil, attendee_timezone: nil)
|
|
39
|
+
# Some parameter documentations has been truncated, see
|
|
40
|
+
# {Telnyx::Models::BookAppointmentToolParams} for more details.
|
|
41
|
+
#
|
|
42
|
+
# @param api_key_ref [String] Reference to an integration secret that contains your Cal.com API key. You would
|
|
43
|
+
#
|
|
44
|
+
# @param event_type_id [Integer] Event Type ID for which slots are being fetched. [cal.com](https://cal.com/docs/
|
|
45
|
+
#
|
|
46
|
+
# @param attendee_name [String] The name of the attendee [cal.com](https://cal.com/docs/api-reference/v2/booking
|
|
47
|
+
#
|
|
48
|
+
# @param attendee_timezone [String] The timezone of the attendee [cal.com](https://cal.com/docs/api-reference/v2/boo
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
end
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class CallAssistantRequest < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute id
|
|
7
|
+
# The identifier of the AI assistant to use.
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute dynamic_variables
|
|
13
|
+
# Map of dynamic variables and their default values. Dynamic variables can be
|
|
14
|
+
# referenced in instructions, greeting, and tool definitions using the
|
|
15
|
+
# `{{variable_name}}` syntax. Call-control-agent automatically merges in
|
|
16
|
+
# `telnyx_call_*` variables (telnyx_call_to, telnyx_call_from,
|
|
17
|
+
# telnyx_conversation_channel, telnyx_agent_target, telnyx_end_user_target,
|
|
18
|
+
# telnyx_call_caller_id_name) and custom header variables.
|
|
19
|
+
#
|
|
20
|
+
# @return [Hash{Symbol=>String, Float, Boolean}, nil]
|
|
21
|
+
optional :dynamic_variables,
|
|
22
|
+
-> { Telnyx::Internal::Type::HashOf[union: Telnyx::CallAssistantRequest::DynamicVariable] }
|
|
23
|
+
|
|
24
|
+
# @!attribute external_llm
|
|
25
|
+
# External LLM configuration for bringing your own LLM endpoint.
|
|
26
|
+
#
|
|
27
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
28
|
+
optional :external_llm, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
29
|
+
|
|
30
|
+
# @!attribute fallback_config
|
|
31
|
+
# Fallback LLM configuration used when the primary LLM provider is unavailable.
|
|
32
|
+
#
|
|
33
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
34
|
+
optional :fallback_config, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
35
|
+
|
|
36
|
+
# @!attribute greeting
|
|
37
|
+
# Initial greeting text spoken when the assistant starts. Can be plain text for
|
|
38
|
+
# any voice or SSML for `AWS.Polly.<voice_id>` voices. There is a 3,000 character
|
|
39
|
+
# limit.
|
|
40
|
+
#
|
|
41
|
+
# @return [String, nil]
|
|
42
|
+
optional :greeting, String
|
|
43
|
+
|
|
44
|
+
# @!attribute instructions
|
|
45
|
+
# System instructions for the voice assistant. Can be templated with
|
|
46
|
+
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
|
|
47
|
+
# This will overwrite the instructions set in the assistant configuration.
|
|
48
|
+
#
|
|
49
|
+
# @return [String, nil]
|
|
50
|
+
optional :instructions, String
|
|
51
|
+
|
|
52
|
+
# @!attribute llm_api_key_ref
|
|
53
|
+
# Integration secret identifier for the LLM provider API key. Use this field to
|
|
54
|
+
# reference an
|
|
55
|
+
# [integration secret](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
56
|
+
# containing your LLM provider API key. Supports any LLM provider (OpenAI,
|
|
57
|
+
# Anthropic, etc.).
|
|
58
|
+
#
|
|
59
|
+
# @return [String, nil]
|
|
60
|
+
optional :llm_api_key_ref, String
|
|
61
|
+
|
|
62
|
+
# @!attribute mcp_servers
|
|
63
|
+
# MCP (Model Context Protocol) server configurations for extending the assistant's
|
|
64
|
+
# capabilities with external tools and data sources.
|
|
65
|
+
#
|
|
66
|
+
# @return [Array<Hash{Symbol=>Object}>, nil]
|
|
67
|
+
optional :mcp_servers,
|
|
68
|
+
Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
|
|
69
|
+
|
|
70
|
+
# @!attribute model
|
|
71
|
+
# LLM model override for this call. If omitted, the assistant's configured model
|
|
72
|
+
# is used.
|
|
73
|
+
#
|
|
74
|
+
# @return [String, nil]
|
|
75
|
+
optional :model, String
|
|
76
|
+
|
|
77
|
+
# @!attribute name
|
|
78
|
+
# Assistant name override for this call.
|
|
79
|
+
#
|
|
80
|
+
# @return [String, nil]
|
|
81
|
+
optional :name, String
|
|
82
|
+
|
|
83
|
+
# @!attribute observability_settings
|
|
84
|
+
# Observability configuration for the assistant session, including Langfuse
|
|
85
|
+
# integration for tracing and monitoring.
|
|
86
|
+
#
|
|
87
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
88
|
+
optional :observability_settings, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
89
|
+
|
|
90
|
+
# @!attribute openai_api_key_ref
|
|
91
|
+
# @deprecated This field is deprecated and will be removed soon
|
|
92
|
+
#
|
|
93
|
+
# Deprecated — use `llm_api_key_ref` instead. Integration secret identifier for
|
|
94
|
+
# the OpenAI API key. This field is maintained for backward compatibility;
|
|
95
|
+
# `llm_api_key_ref` is the canonical field name and supports all LLM providers.
|
|
96
|
+
#
|
|
97
|
+
# @return [String, nil]
|
|
98
|
+
optional :openai_api_key_ref, String
|
|
99
|
+
|
|
100
|
+
# @!attribute tools
|
|
101
|
+
# Inline tool definitions available to the assistant (webhook, retrieval,
|
|
102
|
+
# transfer, hangup, etc.). Overrides the assistant's stored tools if provided.
|
|
103
|
+
#
|
|
104
|
+
# @return [Array<Telnyx::Models::BookAppointmentTool, Telnyx::Models::CheckAvailabilityTool, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::CallControlRetrievalTool>, nil]
|
|
105
|
+
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::CallAssistantRequest::Tool] }
|
|
106
|
+
|
|
107
|
+
# @!method initialize(id:, dynamic_variables: nil, external_llm: nil, fallback_config: nil, greeting: nil, instructions: nil, llm_api_key_ref: nil, mcp_servers: nil, model: nil, name: nil, observability_settings: nil, openai_api_key_ref: nil, tools: nil)
|
|
108
|
+
# Some parameter documentations has been truncated, see
|
|
109
|
+
# {Telnyx::Models::CallAssistantRequest} for more details.
|
|
110
|
+
#
|
|
111
|
+
# AI Assistant configuration. All fields except `id` are optional — the
|
|
112
|
+
# assistant's stored configuration will be used as fallback for any omitted
|
|
113
|
+
# fields.
|
|
114
|
+
#
|
|
115
|
+
# @param id [String] The identifier of the AI assistant to use.
|
|
116
|
+
#
|
|
117
|
+
# @param dynamic_variables [Hash{Symbol=>String, Float, Boolean}] Map of dynamic variables and their default values. Dynamic variables can be refe
|
|
118
|
+
#
|
|
119
|
+
# @param external_llm [Hash{Symbol=>Object}] External LLM configuration for bringing your own LLM endpoint.
|
|
120
|
+
#
|
|
121
|
+
# @param fallback_config [Hash{Symbol=>Object}] Fallback LLM configuration used when the primary LLM provider is unavailable.
|
|
122
|
+
#
|
|
123
|
+
# @param greeting [String] Initial greeting text spoken when the assistant starts. Can be plain text for an
|
|
124
|
+
#
|
|
125
|
+
# @param instructions [String] System instructions for the voice assistant. Can be templated with [dynamic vari
|
|
126
|
+
#
|
|
127
|
+
# @param llm_api_key_ref [String] Integration secret identifier for the LLM provider API key. Use this field to re
|
|
128
|
+
#
|
|
129
|
+
# @param mcp_servers [Array<Hash{Symbol=>Object}>] MCP (Model Context Protocol) server configurations for extending the assistant's
|
|
130
|
+
#
|
|
131
|
+
# @param model [String] LLM model override for this call. If omitted, the assistant's configured model i
|
|
132
|
+
#
|
|
133
|
+
# @param name [String] Assistant name override for this call.
|
|
134
|
+
#
|
|
135
|
+
# @param observability_settings [Hash{Symbol=>Object}] Observability configuration for the assistant session, including Langfuse integr
|
|
136
|
+
#
|
|
137
|
+
# @param openai_api_key_ref [String] Deprecated — use `llm_api_key_ref` instead. Integration secret identifier for th
|
|
138
|
+
#
|
|
139
|
+
# @param tools [Array<Telnyx::Models::BookAppointmentTool, Telnyx::Models::CheckAvailabilityTool, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::CallControlRetrievalTool>] Inline tool definitions available to the assistant (webhook, retrieval, transfer
|
|
140
|
+
|
|
141
|
+
module DynamicVariable
|
|
142
|
+
extend Telnyx::Internal::Type::Union
|
|
143
|
+
|
|
144
|
+
variant String
|
|
145
|
+
|
|
146
|
+
variant Float
|
|
147
|
+
|
|
148
|
+
variant Telnyx::Internal::Type::Boolean
|
|
149
|
+
|
|
150
|
+
# @!method self.variants
|
|
151
|
+
# @return [Array(String, Float, Boolean)]
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
module Tool
|
|
155
|
+
extend Telnyx::Internal::Type::Union
|
|
156
|
+
|
|
157
|
+
discriminator :type
|
|
158
|
+
|
|
159
|
+
variant :book_appointment, -> { Telnyx::BookAppointmentTool }
|
|
160
|
+
|
|
161
|
+
variant :check_availability, -> { Telnyx::CheckAvailabilityTool }
|
|
162
|
+
|
|
163
|
+
variant :webhook, -> { Telnyx::AI::WebhookTool }
|
|
164
|
+
|
|
165
|
+
variant :hangup, -> { Telnyx::AI::HangupTool }
|
|
166
|
+
|
|
167
|
+
variant :transfer, -> { Telnyx::AI::TransferTool }
|
|
168
|
+
|
|
169
|
+
variant :retrieval, -> { Telnyx::CallControlRetrievalTool }
|
|
170
|
+
|
|
171
|
+
# @!method self.variants
|
|
172
|
+
# @return [Array(Telnyx::Models::BookAppointmentTool, Telnyx::Models::CheckAvailabilityTool, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::CallControlRetrievalTool)]
|
|
173
|
+
end
|
|
174
|
+
end
|
|
175
|
+
end
|
|
176
|
+
end
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class CallControlBucketIDs < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute bucket_ids
|
|
7
|
+
#
|
|
8
|
+
# @return [Array<String>]
|
|
9
|
+
required :bucket_ids, Telnyx::Internal::Type::ArrayOf[String]
|
|
10
|
+
|
|
11
|
+
# @!attribute max_num_results
|
|
12
|
+
# The maximum number of results to retrieve as context for the language model.
|
|
13
|
+
#
|
|
14
|
+
# @return [Integer, nil]
|
|
15
|
+
optional :max_num_results, Integer
|
|
16
|
+
|
|
17
|
+
# @!method initialize(bucket_ids:, max_num_results: nil)
|
|
18
|
+
# @param bucket_ids [Array<String>]
|
|
19
|
+
#
|
|
20
|
+
# @param max_num_results [Integer] The maximum number of results to retrieve as context for the language model.
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class CallControlRetrievalTool < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute retrieval
|
|
7
|
+
#
|
|
8
|
+
# @return [Telnyx::Models::CallControlBucketIDs]
|
|
9
|
+
required :retrieval, -> { Telnyx::CallControlBucketIDs }
|
|
10
|
+
|
|
11
|
+
# @!attribute type
|
|
12
|
+
#
|
|
13
|
+
# @return [Symbol, Telnyx::Models::CallControlRetrievalTool::Type]
|
|
14
|
+
required :type, enum: -> { Telnyx::CallControlRetrievalTool::Type }
|
|
15
|
+
|
|
16
|
+
# @!method initialize(retrieval:, type:)
|
|
17
|
+
# @param retrieval [Telnyx::Models::CallControlBucketIDs]
|
|
18
|
+
# @param type [Symbol, Telnyx::Models::CallControlRetrievalTool::Type]
|
|
19
|
+
|
|
20
|
+
# @see Telnyx::Models::CallControlRetrievalTool#type
|
|
21
|
+
module Type
|
|
22
|
+
extend Telnyx::Internal::Type::Enum
|
|
23
|
+
|
|
24
|
+
RETRIEVAL = :retrieval
|
|
25
|
+
|
|
26
|
+
# @!method self.values
|
|
27
|
+
# @return [Array<Symbol>]
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
@@ -58,6 +58,14 @@ module Telnyx
|
|
|
58
58
|
optional :answering_machine_detection_config,
|
|
59
59
|
-> { Telnyx::CallDialParams::AnsweringMachineDetectionConfig }
|
|
60
60
|
|
|
61
|
+
# @!attribute assistant
|
|
62
|
+
# AI Assistant configuration. All fields except `id` are optional — the
|
|
63
|
+
# assistant's stored configuration will be used as fallback for any omitted
|
|
64
|
+
# fields.
|
|
65
|
+
#
|
|
66
|
+
# @return [Telnyx::Models::CallAssistantRequest, nil]
|
|
67
|
+
optional :assistant, -> { Telnyx::CallAssistantRequest }
|
|
68
|
+
|
|
61
69
|
# @!attribute audio_url
|
|
62
70
|
# The URL of a file to be played back to the callee when the call is answered. The
|
|
63
71
|
# URL can point to either a WAV or MP3 file. media_name and audio_url cannot be
|
|
@@ -178,6 +186,14 @@ module Telnyx
|
|
|
178
186
|
# @return [Boolean, nil]
|
|
179
187
|
optional :prevent_double_bridge, Telnyx::Internal::Type::Boolean
|
|
180
188
|
|
|
189
|
+
# @!attribute privacy
|
|
190
|
+
# Indicates the privacy level to be used for the call. When set to `id`, caller ID
|
|
191
|
+
# information (name and number) will be hidden from the called party. When set to
|
|
192
|
+
# `none` or omitted, caller ID will be shown normally.
|
|
193
|
+
#
|
|
194
|
+
# @return [Symbol, Telnyx::Models::CallDialParams::Privacy, nil]
|
|
195
|
+
optional :privacy, enum: -> { Telnyx::CallDialParams::Privacy }
|
|
196
|
+
|
|
181
197
|
# @!attribute record
|
|
182
198
|
# Start recording automatically after an event. Disabled by default.
|
|
183
199
|
#
|
|
@@ -399,7 +415,7 @@ module Telnyx
|
|
|
399
415
|
# @return [Symbol, Telnyx::Models::CallDialParams::WebhookURLMethod, nil]
|
|
400
416
|
optional :webhook_url_method, enum: -> { Telnyx::CallDialParams::WebhookURLMethod }
|
|
401
417
|
|
|
402
|
-
# @!method initialize(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, custom_headers: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, prevent_double_bridge: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_url: nil, webhook_url_method: nil, request_options: {})
|
|
418
|
+
# @!method initialize(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, assistant: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, custom_headers: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, prevent_double_bridge: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_url: nil, webhook_url_method: nil, request_options: {})
|
|
403
419
|
# Some parameter documentations has been truncated, see
|
|
404
420
|
# {Telnyx::Models::CallDialParams} for more details.
|
|
405
421
|
#
|
|
@@ -413,6 +429,8 @@ module Telnyx
|
|
|
413
429
|
#
|
|
414
430
|
# @param answering_machine_detection_config [Telnyx::Models::CallDialParams::AnsweringMachineDetectionConfig] Optional configuration parameters to modify 'answering_machine_detection' perfor
|
|
415
431
|
#
|
|
432
|
+
# @param assistant [Telnyx::Models::CallAssistantRequest] AI Assistant configuration. All fields except `id` are optional — the assistant'
|
|
433
|
+
#
|
|
416
434
|
# @param audio_url [String] The URL of a file to be played back to the callee when the call is answered. The
|
|
417
435
|
#
|
|
418
436
|
# @param billing_group_id [String] Use this field to set the Billing Group ID for the call. Must be a valid and exi
|
|
@@ -447,6 +465,8 @@ module Telnyx
|
|
|
447
465
|
#
|
|
448
466
|
# @param prevent_double_bridge [Boolean] Prevents bridging and hangs up the call if the target is already bridged. Disabl
|
|
449
467
|
#
|
|
468
|
+
# @param privacy [Symbol, Telnyx::Models::CallDialParams::Privacy] Indicates the privacy level to be used for the call. When set to `id`, caller ID
|
|
469
|
+
#
|
|
450
470
|
# @param record [Symbol, Telnyx::Models::CallDialParams::Record] Start recording automatically after an event. Disabled by default.
|
|
451
471
|
#
|
|
452
472
|
# @param record_channels [Symbol, Telnyx::Models::CallDialParams::RecordChannels] Defines which channel should be recorded ('single' or 'dual') when `record` is s
|
|
@@ -848,6 +868,19 @@ module Telnyx
|
|
|
848
868
|
# @return [Array<Symbol>]
|
|
849
869
|
end
|
|
850
870
|
|
|
871
|
+
# Indicates the privacy level to be used for the call. When set to `id`, caller ID
|
|
872
|
+
# information (name and number) will be hidden from the called party. When set to
|
|
873
|
+
# `none` or omitted, caller ID will be shown normally.
|
|
874
|
+
module Privacy
|
|
875
|
+
extend Telnyx::Internal::Type::Enum
|
|
876
|
+
|
|
877
|
+
ID = :id
|
|
878
|
+
NONE = :none
|
|
879
|
+
|
|
880
|
+
# @!method self.values
|
|
881
|
+
# @return [Array<Symbol>]
|
|
882
|
+
end
|
|
883
|
+
|
|
851
884
|
# Start recording automatically after an event. Disabled by default.
|
|
852
885
|
module Record
|
|
853
886
|
extend Telnyx::Internal::Type::Enum
|
|
@@ -13,6 +13,14 @@ module Telnyx
|
|
|
13
13
|
# @return [String]
|
|
14
14
|
required :call_control_id, String
|
|
15
15
|
|
|
16
|
+
# @!attribute assistant
|
|
17
|
+
# AI Assistant configuration. All fields except `id` are optional — the
|
|
18
|
+
# assistant's stored configuration will be used as fallback for any omitted
|
|
19
|
+
# fields.
|
|
20
|
+
#
|
|
21
|
+
# @return [Telnyx::Models::CallAssistantRequest, nil]
|
|
22
|
+
optional :assistant, -> { Telnyx::CallAssistantRequest }
|
|
23
|
+
|
|
16
24
|
# @!attribute billing_group_id
|
|
17
25
|
# Use this field to set the Billing Group ID for the call. Must be a valid and
|
|
18
26
|
# existing Billing Group ID.
|
|
@@ -210,12 +218,14 @@ module Telnyx
|
|
|
210
218
|
# @return [Symbol, Telnyx::Models::Calls::ActionAnswerParams::WebhookURLsMethod, nil]
|
|
211
219
|
optional :webhook_urls_method, enum: -> { Telnyx::Calls::ActionAnswerParams::WebhookURLsMethod }
|
|
212
220
|
|
|
213
|
-
# @!method initialize(call_control_id:, billing_group_id: nil, client_state: nil, command_id: nil, custom_headers: nil, preferred_codecs: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_silence_when_idle: nil, sip_headers: nil, sound_modifications: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_track: nil, stream_url: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
|
|
221
|
+
# @!method initialize(call_control_id:, assistant: nil, billing_group_id: nil, client_state: nil, command_id: nil, custom_headers: nil, preferred_codecs: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_silence_when_idle: nil, sip_headers: nil, sound_modifications: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_track: nil, stream_url: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
|
|
214
222
|
# Some parameter documentations has been truncated, see
|
|
215
223
|
# {Telnyx::Models::Calls::ActionAnswerParams} for more details.
|
|
216
224
|
#
|
|
217
225
|
# @param call_control_id [String]
|
|
218
226
|
#
|
|
227
|
+
# @param assistant [Telnyx::Models::CallAssistantRequest] AI Assistant configuration. All fields except `id` are optional — the assistant'
|
|
228
|
+
#
|
|
219
229
|
# @param billing_group_id [String] Use this field to set the Billing Group ID for the call. Must be a valid and exi
|
|
220
230
|
#
|
|
221
231
|
# @param client_state [String] Use this field to add state to every subsequent webhook. It must be a valid Base
|
|
@@ -14,10 +14,12 @@ module Telnyx
|
|
|
14
14
|
required :call_control_id, String
|
|
15
15
|
|
|
16
16
|
# @!attribute assistant
|
|
17
|
-
# AI Assistant configuration
|
|
17
|
+
# AI Assistant configuration. All fields except `id` are optional — the
|
|
18
|
+
# assistant's stored configuration will be used as fallback for any omitted
|
|
19
|
+
# fields.
|
|
18
20
|
#
|
|
19
|
-
# @return [Telnyx::Models::
|
|
20
|
-
optional :assistant, -> { Telnyx::
|
|
21
|
+
# @return [Telnyx::Models::CallAssistantRequest, nil]
|
|
22
|
+
optional :assistant, -> { Telnyx::CallAssistantRequest }
|
|
21
23
|
|
|
22
24
|
# @!attribute client_state
|
|
23
25
|
# Use this field to add state to every subsequent webhook. It must be a valid
|
|
@@ -119,7 +121,7 @@ module Telnyx
|
|
|
119
121
|
#
|
|
120
122
|
# @param call_control_id [String]
|
|
121
123
|
#
|
|
122
|
-
# @param assistant [Telnyx::Models::
|
|
124
|
+
# @param assistant [Telnyx::Models::CallAssistantRequest] AI Assistant configuration. All fields except `id` are optional — the assistant'
|
|
123
125
|
#
|
|
124
126
|
# @param client_state [String] Use this field to add state to every subsequent webhook. It must be a valid Base
|
|
125
127
|
#
|
|
@@ -143,41 +145,6 @@ module Telnyx
|
|
|
143
145
|
#
|
|
144
146
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
145
147
|
|
|
146
|
-
class Assistant < Telnyx::Internal::Type::BaseModel
|
|
147
|
-
# @!attribute id
|
|
148
|
-
# The identifier of the AI assistant to use
|
|
149
|
-
#
|
|
150
|
-
# @return [String, nil]
|
|
151
|
-
optional :id, String
|
|
152
|
-
|
|
153
|
-
# @!attribute instructions
|
|
154
|
-
# The system instructions that the voice assistant uses during the start assistant
|
|
155
|
-
# command. This will overwrite the instructions set in the assistant
|
|
156
|
-
# configuration.
|
|
157
|
-
#
|
|
158
|
-
# @return [String, nil]
|
|
159
|
-
optional :instructions, String
|
|
160
|
-
|
|
161
|
-
# @!attribute openai_api_key_ref
|
|
162
|
-
# Reference to the OpenAI API key. Required only when using OpenAI models
|
|
163
|
-
#
|
|
164
|
-
# @return [String, nil]
|
|
165
|
-
optional :openai_api_key_ref, String
|
|
166
|
-
|
|
167
|
-
# @!method initialize(id: nil, instructions: nil, openai_api_key_ref: nil)
|
|
168
|
-
# Some parameter documentations has been truncated, see
|
|
169
|
-
# {Telnyx::Models::Calls::ActionStartAIAssistantParams::Assistant} for more
|
|
170
|
-
# details.
|
|
171
|
-
#
|
|
172
|
-
# AI Assistant configuration
|
|
173
|
-
#
|
|
174
|
-
# @param id [String] The identifier of the AI assistant to use
|
|
175
|
-
#
|
|
176
|
-
# @param instructions [String] The system instructions that the voice assistant uses during the start assistant
|
|
177
|
-
#
|
|
178
|
-
# @param openai_api_key_ref [String] Reference to the OpenAI API key. Required only when using OpenAI models
|
|
179
|
-
end
|
|
180
|
-
|
|
181
148
|
# Messages sent by an end user
|
|
182
149
|
module MessageHistory
|
|
183
150
|
extend Telnyx::Internal::Type::Union
|
|
@@ -130,6 +130,14 @@ module Telnyx
|
|
|
130
130
|
# @return [String, nil]
|
|
131
131
|
optional :preferred_codecs, String
|
|
132
132
|
|
|
133
|
+
# @!attribute privacy
|
|
134
|
+
# Indicates the privacy level to be used for the call. When set to `id`, caller ID
|
|
135
|
+
# information (name and number) will be hidden from the called party. When set to
|
|
136
|
+
# `none` or omitted, caller ID will be shown normally.
|
|
137
|
+
#
|
|
138
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionTransferParams::Privacy, nil]
|
|
139
|
+
optional :privacy, enum: -> { Telnyx::Calls::ActionTransferParams::Privacy }
|
|
140
|
+
|
|
133
141
|
# @!attribute record
|
|
134
142
|
# Start recording automatically after an event. Disabled by default.
|
|
135
143
|
#
|
|
@@ -290,7 +298,7 @@ module Telnyx
|
|
|
290
298
|
# @return [Symbol, Telnyx::Models::Calls::ActionTransferParams::WebhookURLsMethod, nil]
|
|
291
299
|
optional :webhook_urls_method, enum: -> { Telnyx::Calls::ActionTransferParams::WebhookURLsMethod }
|
|
292
300
|
|
|
293
|
-
# @!method initialize(call_control_id:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, client_state: nil, command_id: nil, custom_headers: nil, early_media: nil, from: nil, from_display_name: nil, media_encryption: nil, media_name: nil, mute_dtmf: nil, park_after_unbridge: nil, preferred_codecs: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, target_leg_client_state: nil, time_limit_secs: nil, timeout_secs: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
|
|
301
|
+
# @!method initialize(call_control_id:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, client_state: nil, command_id: nil, custom_headers: nil, early_media: nil, from: nil, from_display_name: nil, media_encryption: nil, media_name: nil, mute_dtmf: nil, park_after_unbridge: nil, preferred_codecs: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, target_leg_client_state: nil, time_limit_secs: nil, timeout_secs: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
|
|
294
302
|
# Some parameter documentations has been truncated, see
|
|
295
303
|
# {Telnyx::Models::Calls::ActionTransferParams} for more details.
|
|
296
304
|
#
|
|
@@ -326,6 +334,8 @@ module Telnyx
|
|
|
326
334
|
#
|
|
327
335
|
# @param preferred_codecs [String] The list of comma-separated codecs in order of preference to be used during the
|
|
328
336
|
#
|
|
337
|
+
# @param privacy [Symbol, Telnyx::Models::Calls::ActionTransferParams::Privacy] Indicates the privacy level to be used for the call. When set to `id`, caller ID
|
|
338
|
+
#
|
|
329
339
|
# @param record [Symbol, Telnyx::Models::Calls::ActionTransferParams::Record] Start recording automatically after an event. Disabled by default.
|
|
330
340
|
#
|
|
331
341
|
# @param record_channels [Symbol, Telnyx::Models::Calls::ActionTransferParams::RecordChannels] Defines which channel should be recorded ('single' or 'dual') when `record` is s
|
|
@@ -513,6 +523,19 @@ module Telnyx
|
|
|
513
523
|
# @return [Array<Symbol>]
|
|
514
524
|
end
|
|
515
525
|
|
|
526
|
+
# Indicates the privacy level to be used for the call. When set to `id`, caller ID
|
|
527
|
+
# information (name and number) will be hidden from the called party. When set to
|
|
528
|
+
# `none` or omitted, caller ID will be shown normally.
|
|
529
|
+
module Privacy
|
|
530
|
+
extend Telnyx::Internal::Type::Enum
|
|
531
|
+
|
|
532
|
+
ID = :id
|
|
533
|
+
NONE = :none
|
|
534
|
+
|
|
535
|
+
# @!method self.values
|
|
536
|
+
# @return [Array<Symbol>]
|
|
537
|
+
end
|
|
538
|
+
|
|
516
539
|
# Start recording automatically after an event. Disabled by default.
|
|
517
540
|
module Record
|
|
518
541
|
extend Telnyx::Internal::Type::Enum
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class CheckAvailabilityTool < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute check_availability
|
|
7
|
+
#
|
|
8
|
+
# @return [Telnyx::Models::CheckAvailabilityToolParams]
|
|
9
|
+
required :check_availability, -> { Telnyx::CheckAvailabilityToolParams }
|
|
10
|
+
|
|
11
|
+
# @!attribute type
|
|
12
|
+
#
|
|
13
|
+
# @return [Symbol, Telnyx::Models::CheckAvailabilityTool::Type]
|
|
14
|
+
required :type, enum: -> { Telnyx::CheckAvailabilityTool::Type }
|
|
15
|
+
|
|
16
|
+
# @!method initialize(check_availability:, type:)
|
|
17
|
+
# @param check_availability [Telnyx::Models::CheckAvailabilityToolParams]
|
|
18
|
+
# @param type [Symbol, Telnyx::Models::CheckAvailabilityTool::Type]
|
|
19
|
+
|
|
20
|
+
# @see Telnyx::Models::CheckAvailabilityTool#type
|
|
21
|
+
module Type
|
|
22
|
+
extend Telnyx::Internal::Type::Enum
|
|
23
|
+
|
|
24
|
+
CHECK_AVAILABILITY = :check_availability
|
|
25
|
+
|
|
26
|
+
# @!method self.values
|
|
27
|
+
# @return [Array<Symbol>]
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class CheckAvailabilityToolParams < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute api_key_ref
|
|
7
|
+
# Reference to an integration secret that contains your Cal.com API key. You would
|
|
8
|
+
# pass the `identifier` for an integration secret
|
|
9
|
+
# [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
10
|
+
# that refers to your Cal.com API key.
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :api_key_ref, String
|
|
14
|
+
|
|
15
|
+
# @!attribute event_type_id
|
|
16
|
+
# Event Type ID for which slots are being fetched.
|
|
17
|
+
# [cal.com](https://cal.com/docs/api-reference/v2/slots/get-available-slots#parameter-event-type-id)
|
|
18
|
+
#
|
|
19
|
+
# @return [Integer]
|
|
20
|
+
required :event_type_id, Integer
|
|
21
|
+
|
|
22
|
+
# @!method initialize(api_key_ref:, event_type_id:)
|
|
23
|
+
# Some parameter documentations has been truncated, see
|
|
24
|
+
# {Telnyx::Models::CheckAvailabilityToolParams} for more details.
|
|
25
|
+
#
|
|
26
|
+
# @param api_key_ref [String] Reference to an integration secret that contains your Cal.com API key. You would
|
|
27
|
+
#
|
|
28
|
+
# @param event_type_id [Integer] Event Type ID for which slots are being fetched. [cal.com](https://cal.com/docs/
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
@@ -180,7 +180,7 @@ module Telnyx
|
|
|
180
180
|
NUMBER_OF_EMPLOYEES_201_500 = :"201-500"
|
|
181
181
|
NUMBER_OF_EMPLOYEES_501_2000 = :"501-2000"
|
|
182
182
|
NUMBER_OF_EMPLOYEES_2001_10000 = :"2001-10000"
|
|
183
|
-
|
|
183
|
+
NUMBER_OF_EMPLOYEES_10001_PLUS = :"10001+"
|
|
184
184
|
|
|
185
185
|
# @!method self.values
|
|
186
186
|
# @return [Array<Symbol>]
|
|
@@ -196,7 +196,7 @@ module Telnyx
|
|
|
196
196
|
NUMBER_OF_EMPLOYEES_201_500 = :"201-500"
|
|
197
197
|
NUMBER_OF_EMPLOYEES_501_2000 = :"501-2000"
|
|
198
198
|
NUMBER_OF_EMPLOYEES_2001_10000 = :"2001-10000"
|
|
199
|
-
|
|
199
|
+
NUMBER_OF_EMPLOYEES_10001_PLUS = :"10001+"
|
|
200
200
|
|
|
201
201
|
# @!method self.values
|
|
202
202
|
# @return [Array<Symbol>]
|
|
@@ -156,7 +156,7 @@ module Telnyx
|
|
|
156
156
|
NUMBER_OF_EMPLOYEES_201_500 = :"201-500"
|
|
157
157
|
NUMBER_OF_EMPLOYEES_501_2000 = :"501-2000"
|
|
158
158
|
NUMBER_OF_EMPLOYEES_2001_10000 = :"2001-10000"
|
|
159
|
-
|
|
159
|
+
NUMBER_OF_EMPLOYEES_10001_PLUS = :"10001+"
|
|
160
160
|
|
|
161
161
|
# @!method self.values
|
|
162
162
|
# @return [Array<Symbol>]
|
data/lib/telnyx/models/enterprises/reputation/{number_create_params.rb → number_associate_params.rb}
RENAMED
|
@@ -4,8 +4,8 @@ module Telnyx
|
|
|
4
4
|
module Models
|
|
5
5
|
module Enterprises
|
|
6
6
|
module Reputation
|
|
7
|
-
# @see Telnyx::Resources::Enterprises::Reputation::Numbers#
|
|
8
|
-
class
|
|
7
|
+
# @see Telnyx::Resources::Enterprises::Reputation::Numbers#associate
|
|
8
|
+
class NumberAssociateParams < Telnyx::Internal::Type::BaseModel
|
|
9
9
|
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include Telnyx::Internal::Type::RequestParameters
|
|
11
11
|
|