telnyx 5.150.0 → 5.152.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 +5 -531
- data/README.md +10 -1
- data/lib/telnyx/models/advanced_order_create_params.rb +1 -86
- data/lib/telnyx/models/advanced_order_update_requirement_group_params.rb +1 -88
- data/lib/telnyx/models/ai_retrieve_conversation_histories_params.rb +22 -48
- data/lib/telnyx/models/ai_retrieve_conversation_histories_response.rb +10 -50
- data/lib/telnyx/models/calls/deepgram_nova2_config.rb +23 -1
- data/lib/telnyx/models/calls/deepgram_nova3_config.rb +22 -1
- data/lib/telnyx/models/calls/transcription_start_request.rb +5 -3
- data/lib/telnyx/models/dir/email_verification_status_wrapped.rb +82 -0
- data/lib/telnyx/models/dir/reference.rb +125 -0
- data/lib/telnyx/models/dir/reference_create_params.rb +43 -0
- data/lib/telnyx/models/dir/reference_input.rb +74 -0
- data/lib/telnyx/models/dir/reference_list.rb +18 -0
- data/lib/telnyx/models/dir/{phone_number_delete_all_params.rb → reference_list_params.rb} +3 -9
- data/lib/telnyx/models/dir/reference_update_params.rb +103 -0
- data/lib/telnyx/models/dir/reference_update_response.rb +23 -0
- data/lib/telnyx/models/dir/verify_email_confirm_params.rb +31 -0
- data/lib/telnyx/models/dir/verify_email_create_params.rb +22 -0
- data/lib/telnyx/models/dir/verify_email_list_params.rb +22 -0
- data/lib/telnyx/models/dir_update_infringement_params.rb +6 -2
- data/lib/telnyx/models/enterprises/dir_create_params.rb +10 -10
- data/lib/telnyx/models/public_internet_gateway.rb +24 -1
- data/lib/telnyx/models/storage/kv_create_params.rb +24 -0
- data/lib/telnyx/models/storage/kv_delete_params.rb +22 -0
- data/lib/telnyx/models/storage/kv_list_params.rb +32 -0
- data/lib/telnyx/models/storage/kv_namespace.rb +75 -0
- data/lib/telnyx/models/storage/kv_namespace_response_wrapper.rb +18 -0
- data/lib/telnyx/models/storage/kv_retrieve_params.rb +22 -0
- data/lib/telnyx/models/storage/kvs/key_delete_params.rb +30 -0
- data/lib/telnyx/models/storage/kvs/key_list_params.rb +49 -0
- data/lib/telnyx/models/storage/kvs/key_list_response.rb +82 -0
- data/lib/telnyx/models/storage/kvs/key_retrieve_params.rb +30 -0
- data/lib/telnyx/models/storage/kvs/key_update_params.rb +53 -0
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +9 -69
- data/lib/telnyx/models/virtual_cross_connect_create.rb +176 -2
- data/lib/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_params.rb +31 -0
- data/lib/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rb +54 -0
- data/lib/telnyx/models/wireguard_interface.rb +24 -1
- data/lib/telnyx/resources/ai.rb +20 -21
- data/lib/telnyx/resources/calls/actions.rb +1 -1
- data/lib/telnyx/resources/dir/references.rb +139 -0
- data/lib/telnyx/resources/dir/verify_email.rb +91 -0
- data/lib/telnyx/resources/dir.rb +17 -1
- data/lib/telnyx/resources/documents.rb +1 -1
- data/lib/telnyx/resources/enterprises/dir.rb +3 -3
- data/lib/telnyx/resources/storage/kvs/keys.rb +154 -0
- data/lib/telnyx/resources/storage/kvs.rb +115 -0
- data/lib/telnyx/resources/storage.rb +5 -0
- data/lib/telnyx/resources/whatsapp/phone_numbers.rb +27 -0
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +29 -2
- data/rbi/telnyx/models/advanced_order_create_params.rbi +4 -198
- data/rbi/telnyx/models/advanced_order_update_requirement_group_params.rbi +2 -219
- data/rbi/telnyx/models/ai/assistant_get_texml_response.rbi +1 -1
- data/rbi/telnyx/models/ai/assistants/instruction_enhance_response.rbi +1 -1
- data/rbi/telnyx/models/ai_retrieve_conversation_histories_params.rbi +30 -97
- data/rbi/telnyx/models/ai_retrieve_conversation_histories_response.rbi +10 -85
- data/rbi/telnyx/models/calls/deepgram_nova2_config.rbi +34 -0
- data/rbi/telnyx/models/calls/deepgram_nova3_config.rbi +32 -0
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +5 -0
- data/rbi/telnyx/models/dir/email_verification_status_wrapped.rbi +184 -0
- data/rbi/telnyx/models/dir/reference.rbi +162 -0
- data/rbi/telnyx/models/dir/reference_create_params.rbi +66 -0
- data/rbi/telnyx/models/dir/reference_input.rbi +93 -0
- data/rbi/telnyx/models/dir/reference_list.rbi +29 -0
- data/rbi/telnyx/models/dir/reference_list_params.rbi +37 -0
- data/rbi/telnyx/models/dir/reference_update_params.rbi +154 -0
- data/rbi/telnyx/models/dir/reference_update_response.rbi +39 -0
- data/rbi/telnyx/models/dir/{phone_number_delete_all_params.rbi → verify_email_confirm_params.rbi} +13 -7
- data/rbi/telnyx/models/dir/verify_email_create_params.rbi +40 -0
- data/rbi/telnyx/models/dir/verify_email_list_params.rbi +37 -0
- data/rbi/telnyx/models/dir_update_infringement_params.rbi +4 -2
- data/rbi/telnyx/models/enterprises/dir_create_params.rbi +10 -13
- data/rbi/telnyx/models/messaging_profiles/autoresp_config_delete_response.rbi +1 -1
- data/rbi/telnyx/models/public_internet_gateway.rbi +45 -3
- data/rbi/telnyx/models/storage/kv_create_params.rbi +42 -0
- data/rbi/telnyx/models/storage/kv_delete_params.rbi +37 -0
- data/rbi/telnyx/models/storage/kv_list_params.rbi +59 -0
- data/rbi/telnyx/models/storage/kv_namespace.rbi +131 -0
- data/rbi/telnyx/models/storage/kv_namespace_response_wrapper.rbi +35 -0
- data/rbi/telnyx/models/storage/kv_retrieve_params.rbi +37 -0
- data/rbi/telnyx/models/storage/kvs/key_delete_params.rbi +50 -0
- data/rbi/telnyx/models/storage/kvs/key_list_params.rbi +81 -0
- data/rbi/telnyx/models/storage/kvs/key_list_response.rbi +179 -0
- data/rbi/telnyx/models/storage/kvs/key_retrieve_params.rbi +50 -0
- data/rbi/telnyx/models/storage/kvs/key_update_params.rbi +77 -0
- data/rbi/telnyx/models/sub_number_orders_report_download_response.rbi +1 -1
- data/rbi/telnyx/models/telephony_credential_create_token_response.rbi +1 -1
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +12 -189
- data/rbi/telnyx/models/virtual_cross_connect_create.rbi +265 -7
- data/rbi/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_params.rbi +54 -0
- data/rbi/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rbi +125 -0
- data/rbi/telnyx/models/wireguard_interface.rbi +48 -3
- data/rbi/telnyx/models/wireguard_peer_retrieve_config_response.rbi +1 -1
- data/rbi/telnyx/models.rbi +0 -7
- data/rbi/telnyx/resources/ai.rbi +21 -28
- data/rbi/telnyx/resources/calls/actions.rbi +1 -0
- data/rbi/telnyx/resources/dir/references.rbi +114 -0
- data/rbi/telnyx/resources/dir/verify_email.rbi +70 -0
- data/rbi/telnyx/resources/dir.rbi +13 -1
- data/rbi/telnyx/resources/enterprises/dir.rbi +4 -4
- data/rbi/telnyx/resources/storage/kvs/keys.rbi +115 -0
- data/rbi/telnyx/resources/storage/kvs.rbi +87 -0
- data/rbi/telnyx/resources/storage.rbi +4 -0
- data/rbi/telnyx/resources/whatsapp/phone_numbers.rbi +21 -0
- data/sig/telnyx/models/advanced_order_create_params.rbs +3 -99
- data/sig/telnyx/models/advanced_order_update_requirement_group_params.rbs +3 -94
- data/sig/telnyx/models/ai_retrieve_conversation_histories_params.rbs +15 -34
- data/sig/telnyx/models/ai_retrieve_conversation_histories_response.rbs +0 -24
- data/sig/telnyx/models/calls/deepgram_nova2_config.rbs +14 -0
- data/sig/telnyx/models/calls/deepgram_nova3_config.rbs +14 -0
- data/sig/telnyx/models/calls/transcription_start_request.rbs +1 -0
- data/sig/telnyx/models/dir/email_verification_status_wrapped.rbs +69 -0
- data/sig/telnyx/models/dir/reference.rbs +88 -0
- data/sig/telnyx/models/dir/reference_create_params.rbs +38 -0
- data/sig/telnyx/models/dir/reference_input.rbs +52 -0
- data/sig/telnyx/models/dir/reference_list.rbs +15 -0
- data/sig/telnyx/models/dir/reference_list_params.rbs +25 -0
- data/sig/telnyx/models/dir/reference_update_params.rbs +92 -0
- data/sig/telnyx/models/dir/reference_update_response.rbs +15 -0
- data/sig/telnyx/models/dir/{phone_number_delete_all_params.rbs → verify_email_confirm_params.rbs} +6 -6
- data/sig/telnyx/models/dir/verify_email_create_params.rbs +25 -0
- data/sig/telnyx/models/dir/verify_email_list_params.rbs +25 -0
- data/sig/telnyx/models/enterprises/dir_create_params.rbs +5 -7
- data/sig/telnyx/models/public_internet_gateway.rbs +32 -3
- data/sig/telnyx/models/storage/kv_create_params.rbs +25 -0
- data/sig/telnyx/models/storage/kv_delete_params.rbs +22 -0
- data/sig/telnyx/models/storage/kv_list_params.rbs +34 -0
- data/sig/telnyx/models/storage/kv_namespace.rbs +80 -0
- data/sig/telnyx/models/storage/kv_namespace_response_wrapper.rbs +20 -0
- data/sig/telnyx/models/storage/kv_retrieve_params.rbs +22 -0
- data/sig/telnyx/models/storage/kvs/key_delete_params.rbs +32 -0
- data/sig/telnyx/models/storage/kvs/key_list_params.rbs +46 -0
- data/sig/telnyx/models/storage/kvs/key_list_response.rbs +88 -0
- data/sig/telnyx/models/{enterprises/reputation/loa_patch_all_params.rbs → storage/kvs/key_retrieve_params.rbs} +11 -11
- data/sig/telnyx/models/storage/kvs/key_update_params.rbs +47 -0
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +15 -63
- data/sig/telnyx/models/virtual_cross_connect_create.rbs +138 -7
- data/sig/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_params.rbs +30 -0
- data/sig/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rbs +66 -0
- data/sig/telnyx/models/wireguard_interface.rbs +34 -3
- data/sig/telnyx/models.rbs +0 -1
- data/sig/telnyx/resources/ai.rbs +2 -3
- data/sig/telnyx/resources/dir/references.rbs +35 -0
- data/sig/telnyx/resources/dir/verify_email.rbs +25 -0
- data/sig/telnyx/resources/dir.rbs +4 -0
- data/sig/telnyx/resources/enterprises/dir.rbs +1 -1
- data/sig/telnyx/resources/storage/kvs/keys.rbs +39 -0
- data/sig/telnyx/resources/storage/kvs.rbs +32 -0
- data/sig/telnyx/resources/storage.rbs +2 -0
- data/sig/telnyx/resources/whatsapp/phone_numbers.rbs +6 -0
- metadata +86 -38
- data/lib/telnyx/models/dir/phone_number_create_params.rb +0 -47
- data/lib/telnyx/models/dir/phone_number_create_response.rb +0 -32
- data/lib/telnyx/models/dir/phone_number_delete_all_response.rb +0 -103
- data/lib/telnyx/models/dir_loa_params.rb +0 -79
- data/lib/telnyx/models/dir_retrieve_document_types_params.rb +0 -14
- data/lib/telnyx/models/dir_retrieve_document_types_response.rb +0 -51
- data/lib/telnyx/models/dir_retrieve_infringement_claims_params.rb +0 -40
- data/lib/telnyx/models/dir_retrieve_infringement_claims_response.rb +0 -30
- data/lib/telnyx/models/dir_update_infringement_update_params.rb +0 -134
- data/lib/telnyx/models/enterprises/reputation/loa_create_params.rb +0 -146
- data/lib/telnyx/models/enterprises/reputation/loa_patch_all_params.rb +0 -38
- data/rbi/telnyx/models/dir/phone_number_create_params.rbi +0 -72
- data/rbi/telnyx/models/dir/phone_number_create_response.rbi +0 -48
- data/rbi/telnyx/models/dir/phone_number_delete_all_response.rbi +0 -206
- data/rbi/telnyx/models/dir_loa_params.rbi +0 -120
- data/rbi/telnyx/models/dir_retrieve_document_types_params.rbi +0 -30
- data/rbi/telnyx/models/dir_retrieve_document_types_response.rbi +0 -103
- data/rbi/telnyx/models/dir_retrieve_infringement_claims_params.rbi +0 -66
- data/rbi/telnyx/models/dir_retrieve_infringement_claims_response.rbi +0 -55
- data/rbi/telnyx/models/dir_update_infringement_update_params.rbi +0 -256
- data/rbi/telnyx/models/enterprises/reputation/loa_create_params.rbi +0 -238
- data/rbi/telnyx/models/enterprises/reputation/loa_patch_all_params.rbi +0 -60
- data/sig/telnyx/models/dir/phone_number_create_params.rbs +0 -38
- data/sig/telnyx/models/dir/phone_number_create_response.rbs +0 -16
- data/sig/telnyx/models/dir/phone_number_delete_all_response.rbs +0 -86
- data/sig/telnyx/models/dir_loa_params.rbs +0 -61
- data/sig/telnyx/models/dir_retrieve_document_types_params.rbs +0 -15
- data/sig/telnyx/models/dir_retrieve_document_types_response.rbs +0 -41
- data/sig/telnyx/models/dir_retrieve_infringement_claims_params.rbs +0 -36
- data/sig/telnyx/models/dir_retrieve_infringement_claims_response.rbs +0 -25
- data/sig/telnyx/models/dir_update_infringement_update_params.rbs +0 -111
- data/sig/telnyx/models/enterprises/reputation/loa_create_params.rbs +0 -135
|
@@ -7,93 +7,8 @@ module Telnyx
|
|
|
7
7
|
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Telnyx::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
11
|
-
#
|
|
12
|
-
# @return [String, nil]
|
|
13
|
-
optional :area_code, String
|
|
14
|
-
|
|
15
|
-
# @!attribute comments
|
|
16
|
-
#
|
|
17
|
-
# @return [String, nil]
|
|
18
|
-
optional :comments, String
|
|
19
|
-
|
|
20
|
-
# @!attribute country_code
|
|
21
|
-
#
|
|
22
|
-
# @return [String, nil]
|
|
23
|
-
optional :country_code, String
|
|
24
|
-
|
|
25
|
-
# @!attribute customer_reference
|
|
26
|
-
#
|
|
27
|
-
# @return [String, nil]
|
|
28
|
-
optional :customer_reference, String
|
|
29
|
-
|
|
30
|
-
# @!attribute features
|
|
31
|
-
#
|
|
32
|
-
# @return [Array<Symbol, Telnyx::Models::AdvancedOrderCreateParams::Feature>, nil]
|
|
33
|
-
optional :features,
|
|
34
|
-
-> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AdvancedOrderCreateParams::Feature] }
|
|
35
|
-
|
|
36
|
-
# @!attribute phone_number_type
|
|
37
|
-
#
|
|
38
|
-
# @return [Symbol, Telnyx::Models::AdvancedOrderCreateParams::PhoneNumberType, nil]
|
|
39
|
-
optional :phone_number_type, enum: -> { Telnyx::AdvancedOrderCreateParams::PhoneNumberType }
|
|
40
|
-
|
|
41
|
-
# @!attribute quantity
|
|
42
|
-
#
|
|
43
|
-
# @return [Integer, nil]
|
|
44
|
-
optional :quantity, Integer
|
|
45
|
-
|
|
46
|
-
# @!attribute requirement_group_id
|
|
47
|
-
# The ID of the requirement group to associate with this advanced order
|
|
48
|
-
#
|
|
49
|
-
# @return [String, nil]
|
|
50
|
-
optional :requirement_group_id, String
|
|
51
|
-
|
|
52
|
-
# @!method initialize(area_code: nil, comments: nil, country_code: nil, customer_reference: nil, features: nil, phone_number_type: nil, quantity: nil, requirement_group_id: nil, request_options: {})
|
|
53
|
-
# @param area_code [String]
|
|
54
|
-
#
|
|
55
|
-
# @param comments [String]
|
|
56
|
-
#
|
|
57
|
-
# @param country_code [String]
|
|
58
|
-
#
|
|
59
|
-
# @param customer_reference [String]
|
|
60
|
-
#
|
|
61
|
-
# @param features [Array<Symbol, Telnyx::Models::AdvancedOrderCreateParams::Feature>]
|
|
62
|
-
#
|
|
63
|
-
# @param phone_number_type [Symbol, Telnyx::Models::AdvancedOrderCreateParams::PhoneNumberType]
|
|
64
|
-
#
|
|
65
|
-
# @param quantity [Integer]
|
|
66
|
-
#
|
|
67
|
-
# @param requirement_group_id [String] The ID of the requirement group to associate with this advanced order
|
|
68
|
-
#
|
|
10
|
+
# @!method initialize(request_options: {})
|
|
69
11
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
70
|
-
|
|
71
|
-
module Feature
|
|
72
|
-
extend Telnyx::Internal::Type::Enum
|
|
73
|
-
|
|
74
|
-
SMS = :sms
|
|
75
|
-
MMS = :mms
|
|
76
|
-
VOICE = :voice
|
|
77
|
-
FAX = :fax
|
|
78
|
-
EMERGENCY = :emergency
|
|
79
|
-
|
|
80
|
-
# @!method self.values
|
|
81
|
-
# @return [Array<Symbol>]
|
|
82
|
-
end
|
|
83
|
-
|
|
84
|
-
module PhoneNumberType
|
|
85
|
-
extend Telnyx::Internal::Type::Enum
|
|
86
|
-
|
|
87
|
-
LOCAL = :local
|
|
88
|
-
MOBILE = :mobile
|
|
89
|
-
TOLL_FREE = :toll_free
|
|
90
|
-
SHARED_COST = :shared_cost
|
|
91
|
-
NATIONAL = :national
|
|
92
|
-
LANDLINE = :landline
|
|
93
|
-
|
|
94
|
-
# @!method self.values
|
|
95
|
-
# @return [Array<Symbol>]
|
|
96
|
-
end
|
|
97
12
|
end
|
|
98
13
|
end
|
|
99
14
|
end
|
|
@@ -12,96 +12,9 @@ module Telnyx
|
|
|
12
12
|
# @return [String]
|
|
13
13
|
required :advanced_order_id, String
|
|
14
14
|
|
|
15
|
-
# @!
|
|
16
|
-
#
|
|
17
|
-
# @return [String, nil]
|
|
18
|
-
optional :area_code, String
|
|
19
|
-
|
|
20
|
-
# @!attribute comments
|
|
21
|
-
#
|
|
22
|
-
# @return [String, nil]
|
|
23
|
-
optional :comments, String
|
|
24
|
-
|
|
25
|
-
# @!attribute country_code
|
|
26
|
-
#
|
|
27
|
-
# @return [String, nil]
|
|
28
|
-
optional :country_code, String
|
|
29
|
-
|
|
30
|
-
# @!attribute customer_reference
|
|
31
|
-
#
|
|
32
|
-
# @return [String, nil]
|
|
33
|
-
optional :customer_reference, String
|
|
34
|
-
|
|
35
|
-
# @!attribute features
|
|
36
|
-
#
|
|
37
|
-
# @return [Array<Symbol, Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::Feature>, nil]
|
|
38
|
-
optional :features,
|
|
39
|
-
-> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AdvancedOrderUpdateRequirementGroupParams::Feature] }
|
|
40
|
-
|
|
41
|
-
# @!attribute phone_number_type
|
|
42
|
-
#
|
|
43
|
-
# @return [Symbol, Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::PhoneNumberType, nil]
|
|
44
|
-
optional :phone_number_type,
|
|
45
|
-
enum: -> { Telnyx::AdvancedOrderUpdateRequirementGroupParams::PhoneNumberType }
|
|
46
|
-
|
|
47
|
-
# @!attribute quantity
|
|
48
|
-
#
|
|
49
|
-
# @return [Integer, nil]
|
|
50
|
-
optional :quantity, Integer
|
|
51
|
-
|
|
52
|
-
# @!attribute requirement_group_id
|
|
53
|
-
# The ID of the requirement group to associate with this advanced order
|
|
54
|
-
#
|
|
55
|
-
# @return [String, nil]
|
|
56
|
-
optional :requirement_group_id, String
|
|
57
|
-
|
|
58
|
-
# @!method initialize(advanced_order_id:, area_code: nil, comments: nil, country_code: nil, customer_reference: nil, features: nil, phone_number_type: nil, quantity: nil, requirement_group_id: nil, request_options: {})
|
|
15
|
+
# @!method initialize(advanced_order_id:, request_options: {})
|
|
59
16
|
# @param advanced_order_id [String]
|
|
60
|
-
#
|
|
61
|
-
# @param area_code [String]
|
|
62
|
-
#
|
|
63
|
-
# @param comments [String]
|
|
64
|
-
#
|
|
65
|
-
# @param country_code [String]
|
|
66
|
-
#
|
|
67
|
-
# @param customer_reference [String]
|
|
68
|
-
#
|
|
69
|
-
# @param features [Array<Symbol, Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::Feature>]
|
|
70
|
-
#
|
|
71
|
-
# @param phone_number_type [Symbol, Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::PhoneNumberType]
|
|
72
|
-
#
|
|
73
|
-
# @param quantity [Integer]
|
|
74
|
-
#
|
|
75
|
-
# @param requirement_group_id [String] The ID of the requirement group to associate with this advanced order
|
|
76
|
-
#
|
|
77
17
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
78
|
-
|
|
79
|
-
module Feature
|
|
80
|
-
extend Telnyx::Internal::Type::Enum
|
|
81
|
-
|
|
82
|
-
SMS = :sms
|
|
83
|
-
MMS = :mms
|
|
84
|
-
VOICE = :voice
|
|
85
|
-
FAX = :fax
|
|
86
|
-
EMERGENCY = :emergency
|
|
87
|
-
|
|
88
|
-
# @!method self.values
|
|
89
|
-
# @return [Array<Symbol>]
|
|
90
|
-
end
|
|
91
|
-
|
|
92
|
-
module PhoneNumberType
|
|
93
|
-
extend Telnyx::Internal::Type::Enum
|
|
94
|
-
|
|
95
|
-
LOCAL = :local
|
|
96
|
-
MOBILE = :mobile
|
|
97
|
-
TOLL_FREE = :toll_free
|
|
98
|
-
SHARED_COST = :shared_cost
|
|
99
|
-
NATIONAL = :national
|
|
100
|
-
LANDLINE = :landline
|
|
101
|
-
|
|
102
|
-
# @!method self.values
|
|
103
|
-
# @return [Array<Symbol>]
|
|
104
|
-
end
|
|
105
18
|
end
|
|
106
19
|
end
|
|
107
20
|
end
|
|
@@ -9,25 +9,11 @@ module Telnyx
|
|
|
9
9
|
|
|
10
10
|
# @!attribute q
|
|
11
11
|
# Natural language search query. The text is embedded into a 1024-dimensional
|
|
12
|
-
# vector and compared against indexed record chunks using
|
|
12
|
+
# vector and compared against indexed record chunks using semantic similarity.
|
|
13
13
|
#
|
|
14
14
|
# @return [String]
|
|
15
15
|
required :q, String
|
|
16
16
|
|
|
17
|
-
# @!attribute record_type
|
|
18
|
-
# The type of records to search. Each record type is stored in a separate vector
|
|
19
|
-
# index.
|
|
20
|
-
#
|
|
21
|
-
# @return [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesParams::RecordType]
|
|
22
|
-
required :record_type, enum: -> { Telnyx::AIRetrieveConversationHistoriesParams::RecordType }
|
|
23
|
-
|
|
24
|
-
# @!attribute filter_document_id
|
|
25
|
-
# Filter by document identifier (exact match). Populated for knowledge_base
|
|
26
|
-
# records.
|
|
27
|
-
#
|
|
28
|
-
# @return [String, nil]
|
|
29
|
-
optional :filter_document_id, String
|
|
30
|
-
|
|
31
17
|
# @!attribute filter_ingested_at_gte
|
|
32
18
|
# Only include records ingested (chunked, embedded, and indexed) on or after this
|
|
33
19
|
# ISO 8601 timestamp.
|
|
@@ -90,30 +76,31 @@ module Telnyx
|
|
|
90
76
|
# @return [Float, nil]
|
|
91
77
|
optional :min_score, Float
|
|
92
78
|
|
|
93
|
-
# @!attribute
|
|
94
|
-
#
|
|
95
|
-
# regions are queried in parallel (fan-out) and results are merged by cosine
|
|
96
|
-
# similarity score.
|
|
79
|
+
# @!attribute page_number
|
|
80
|
+
# Page number to return (1-based). Defaults to 1.
|
|
97
81
|
#
|
|
98
|
-
# @return [
|
|
99
|
-
optional :
|
|
82
|
+
# @return [Integer, nil]
|
|
83
|
+
optional :page_number, Integer
|
|
100
84
|
|
|
101
|
-
# @!attribute
|
|
102
|
-
#
|
|
85
|
+
# @!attribute page_size
|
|
86
|
+
# Number of results per page. Defaults to 20, maximum 100.
|
|
103
87
|
#
|
|
104
88
|
# @return [Integer, nil]
|
|
105
|
-
optional :
|
|
89
|
+
optional :page_size, Integer
|
|
90
|
+
|
|
91
|
+
# @!attribute region
|
|
92
|
+
# Restrict search to a specific region. When omitted, all regions are queried in
|
|
93
|
+
# parallel (fan-out) and results are merged by similarity score.
|
|
94
|
+
#
|
|
95
|
+
# @return [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesParams::Region, nil]
|
|
96
|
+
optional :region, enum: -> { Telnyx::AIRetrieveConversationHistoriesParams::Region }
|
|
106
97
|
|
|
107
|
-
# @!method initialize(q:,
|
|
98
|
+
# @!method initialize(q:, filter_ingested_at_gte: nil, filter_ingested_at_lte: nil, filter_record_created_at_gte: nil, filter_record_created_at_lte: nil, filter_record_id: nil, filter_region_in: nil, filter_retention: nil, filter_user_id: nil, min_score: nil, page_number: nil, page_size: nil, region: nil, request_options: {})
|
|
108
99
|
# Some parameter documentations has been truncated, see
|
|
109
100
|
# {Telnyx::Models::AIRetrieveConversationHistoriesParams} for more details.
|
|
110
101
|
#
|
|
111
102
|
# @param q [String] Natural language search query. The text is embedded into a 1024-dimensional vect
|
|
112
103
|
#
|
|
113
|
-
# @param record_type [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesParams::RecordType] The type of records to search. Each record type is stored in a separate vector i
|
|
114
|
-
#
|
|
115
|
-
# @param filter_document_id [String] Filter by document identifier (exact match). Populated for knowledge_base record
|
|
116
|
-
#
|
|
117
104
|
# @param filter_ingested_at_gte [Time] Only include records ingested (chunked, embedded, and indexed) on or after this
|
|
118
105
|
#
|
|
119
106
|
# @param filter_ingested_at_lte [Time] Only include records ingested (chunked, embedded, and indexed) on or before this
|
|
@@ -132,29 +119,16 @@ module Telnyx
|
|
|
132
119
|
#
|
|
133
120
|
# @param min_score [Float] Minimum cosine similarity score threshold (0.0 to 1.0). Results below this thres
|
|
134
121
|
#
|
|
135
|
-
# @param
|
|
122
|
+
# @param page_number [Integer] Page number to return (1-based). Defaults to 1.
|
|
123
|
+
#
|
|
124
|
+
# @param page_size [Integer] Number of results per page. Defaults to 20, maximum 100.
|
|
136
125
|
#
|
|
137
|
-
# @param
|
|
126
|
+
# @param region [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesParams::Region] Restrict search to a specific region. When omitted, all regions are queried in p
|
|
138
127
|
#
|
|
139
128
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
140
129
|
|
|
141
|
-
#
|
|
142
|
-
#
|
|
143
|
-
module RecordType
|
|
144
|
-
extend Telnyx::Internal::Type::Enum
|
|
145
|
-
|
|
146
|
-
VOICE = :voice
|
|
147
|
-
MESSAGE = :message
|
|
148
|
-
AI_PIPELINE_STORAGE = :ai_pipeline_storage
|
|
149
|
-
KNOWLEDGE_BASE = :knowledge_base
|
|
150
|
-
|
|
151
|
-
# @!method self.values
|
|
152
|
-
# @return [Array<Symbol>]
|
|
153
|
-
end
|
|
154
|
-
|
|
155
|
-
# Restrict search to a specific region's OpenSearch cluster. When omitted, all
|
|
156
|
-
# regions are queried in parallel (fan-out) and results are merged by cosine
|
|
157
|
-
# similarity score.
|
|
130
|
+
# Restrict search to a specific region. When omitted, all regions are queried in
|
|
131
|
+
# parallel (fan-out) and results are merged by similarity score.
|
|
158
132
|
module Region
|
|
159
133
|
extend Telnyx::Internal::Type::Enum
|
|
160
134
|
|
|
@@ -47,13 +47,6 @@ module Telnyx
|
|
|
47
47
|
# @return [Integer]
|
|
48
48
|
required :chunk_total, Integer
|
|
49
49
|
|
|
50
|
-
# @!attribute document_id
|
|
51
|
-
# Document identifier. Present only for knowledge_base records; null for all other
|
|
52
|
-
# record types.
|
|
53
|
-
#
|
|
54
|
-
# @return [String, nil]
|
|
55
|
-
required :document_id, String, nil?: true
|
|
56
|
-
|
|
57
50
|
# @!attribute ingested_at
|
|
58
51
|
# When the record was chunked, embedded, and indexed (ISO 8601).
|
|
59
52
|
#
|
|
@@ -79,13 +72,6 @@ module Telnyx
|
|
|
79
72
|
# @return [String]
|
|
80
73
|
required :record_id, String
|
|
81
74
|
|
|
82
|
-
# @!attribute record_type
|
|
83
|
-
# Type of the record.
|
|
84
|
-
#
|
|
85
|
-
# @return [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::RecordType]
|
|
86
|
-
required :record_type,
|
|
87
|
-
enum: -> { Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::RecordType }
|
|
88
|
-
|
|
89
75
|
# @!attribute region
|
|
90
76
|
# The region where this record is stored.
|
|
91
77
|
#
|
|
@@ -112,14 +98,13 @@ module Telnyx
|
|
|
112
98
|
required :user_id, String
|
|
113
99
|
|
|
114
100
|
# @!attribute metadata
|
|
115
|
-
# Arbitrary metadata attached to the record at ingestion time.
|
|
116
|
-
#
|
|
117
|
-
# parameters.
|
|
101
|
+
# Arbitrary metadata attached to the record at ingestion time. Filterable via
|
|
102
|
+
# filter[field]=value query parameters.
|
|
118
103
|
#
|
|
119
104
|
# @return [Hash{Symbol=>Object}, nil]
|
|
120
105
|
optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
121
106
|
|
|
122
|
-
# @!method initialize(id:, chunk_index:, chunk_total:,
|
|
107
|
+
# @!method initialize(id:, chunk_index:, chunk_total:, ingested_at:, organization_id:, record_created_at:, record_id:, region:, score:, text:, user_id:, metadata: nil)
|
|
123
108
|
# Some parameter documentations has been truncated, see
|
|
124
109
|
# {Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data} for more
|
|
125
110
|
# details.
|
|
@@ -134,8 +119,6 @@ module Telnyx
|
|
|
134
119
|
#
|
|
135
120
|
# @param chunk_total [Integer] Total number of chunks the parent record was split into.
|
|
136
121
|
#
|
|
137
|
-
# @param document_id [String, nil] Document identifier. Present only for knowledge_base records; null for all other
|
|
138
|
-
#
|
|
139
122
|
# @param ingested_at [Time] When the record was chunked, embedded, and indexed (ISO 8601).
|
|
140
123
|
#
|
|
141
124
|
# @param organization_id [String] Identifier of the organization that owns this record.
|
|
@@ -144,8 +127,6 @@ module Telnyx
|
|
|
144
127
|
#
|
|
145
128
|
# @param record_id [String] Identifier of the parent record. Multiple chunks from the same record share this
|
|
146
129
|
#
|
|
147
|
-
# @param record_type [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::RecordType] Type of the record.
|
|
148
|
-
#
|
|
149
130
|
# @param region [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::Region] The region where this record is stored.
|
|
150
131
|
#
|
|
151
132
|
# @param score [Float] Cosine similarity score between the query vector and this chunk's vector. Higher
|
|
@@ -154,22 +135,7 @@ module Telnyx
|
|
|
154
135
|
#
|
|
155
136
|
# @param user_id [String] Identifier of the user who owns this record.
|
|
156
137
|
#
|
|
157
|
-
# @param metadata [Hash{Symbol=>Object}] Arbitrary metadata attached to the record at ingestion time.
|
|
158
|
-
|
|
159
|
-
# Type of the record.
|
|
160
|
-
#
|
|
161
|
-
# @see Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data#record_type
|
|
162
|
-
module RecordType
|
|
163
|
-
extend Telnyx::Internal::Type::Enum
|
|
164
|
-
|
|
165
|
-
VOICE = :voice
|
|
166
|
-
MESSAGE = :message
|
|
167
|
-
AI_PIPELINE_STORAGE = :ai_pipeline_storage
|
|
168
|
-
KNOWLEDGE_BASE = :knowledge_base
|
|
169
|
-
|
|
170
|
-
# @!method self.values
|
|
171
|
-
# @return [Array<Symbol>]
|
|
172
|
-
end
|
|
138
|
+
# @param metadata [Hash{Symbol=>Object}] Arbitrary metadata attached to the record at ingestion time. Filterable via filt
|
|
173
139
|
|
|
174
140
|
# The region where this record is stored.
|
|
175
141
|
#
|
|
@@ -190,14 +156,13 @@ module Telnyx
|
|
|
190
156
|
# @see Telnyx::Models::AIRetrieveConversationHistoriesResponse#meta
|
|
191
157
|
class Meta < Telnyx::Internal::Type::BaseModel
|
|
192
158
|
# @!attribute page_number
|
|
193
|
-
# Current page number (
|
|
194
|
-
# instead).
|
|
159
|
+
# Current page number (1-based), matching the requested page[number].
|
|
195
160
|
#
|
|
196
161
|
# @return [Integer]
|
|
197
162
|
required :page_number, Integer
|
|
198
163
|
|
|
199
164
|
# @!attribute page_size
|
|
200
|
-
# Number of results per page
|
|
165
|
+
# Number of results per page, matching the requested page[size].
|
|
201
166
|
#
|
|
202
167
|
# @return [Integer]
|
|
203
168
|
required :page_size, Integer
|
|
@@ -209,26 +174,21 @@ module Telnyx
|
|
|
209
174
|
required :total_pages, Integer
|
|
210
175
|
|
|
211
176
|
# @!attribute total_results
|
|
212
|
-
# Total number of matching results across all queried regions
|
|
213
|
-
# truncation).
|
|
177
|
+
# Total number of matching results across all queried regions.
|
|
214
178
|
#
|
|
215
179
|
# @return [Integer]
|
|
216
180
|
required :total_results, Integer
|
|
217
181
|
|
|
218
182
|
# @!method initialize(page_number:, page_size:, total_pages:, total_results:)
|
|
219
|
-
# Some parameter documentations has been truncated, see
|
|
220
|
-
# {Telnyx::Models::AIRetrieveConversationHistoriesResponse::Meta} for more
|
|
221
|
-
# details.
|
|
222
|
-
#
|
|
223
183
|
# Pagination metadata following the standard Telnyx V2 API format.
|
|
224
184
|
#
|
|
225
|
-
# @param page_number [Integer] Current page number (
|
|
185
|
+
# @param page_number [Integer] Current page number (1-based), matching the requested page[number].
|
|
226
186
|
#
|
|
227
|
-
# @param page_size [Integer] Number of results per page
|
|
187
|
+
# @param page_size [Integer] Number of results per page, matching the requested page[size].
|
|
228
188
|
#
|
|
229
189
|
# @param total_pages [Integer] Total number of pages.
|
|
230
190
|
#
|
|
231
|
-
# @param total_results [Integer] Total number of matching results across all queried regions
|
|
191
|
+
# @param total_results [Integer] Total number of matching results across all queried regions.
|
|
232
192
|
end
|
|
233
193
|
end
|
|
234
194
|
end
|
|
@@ -14,6 +14,14 @@ module Telnyx
|
|
|
14
14
|
# @return [Symbol, Telnyx::Models::Calls::DeepgramNova2Config::TranscriptionModel]
|
|
15
15
|
required :transcription_model, enum: -> { Telnyx::Calls::DeepgramNova2Config::TranscriptionModel }
|
|
16
16
|
|
|
17
|
+
# @!attribute hints
|
|
18
|
+
# Nova-2 keyword biasing without intensifiers. Up to 100 terms to bias recognition
|
|
19
|
+
# toward. For weighted biasing, use `keywords_boosting` instead. Nova-2-only; use
|
|
20
|
+
# `keyterms` on Nova-3.
|
|
21
|
+
#
|
|
22
|
+
# @return [Array<String>, nil]
|
|
23
|
+
optional :hints, Telnyx::Internal::Type::ArrayOf[String]
|
|
24
|
+
|
|
17
25
|
# @!attribute interim_results
|
|
18
26
|
# Whether to send also interim results. If set to false, only final results will
|
|
19
27
|
# be sent.
|
|
@@ -35,6 +43,16 @@ module Telnyx
|
|
|
35
43
|
# @return [Symbol, Telnyx::Models::Calls::DeepgramNova2Config::Language, nil]
|
|
36
44
|
optional :language, enum: -> { Telnyx::Calls::DeepgramNova2Config::Language }
|
|
37
45
|
|
|
46
|
+
# @!attribute smart_format
|
|
47
|
+
# Enable Deepgram's smart formatting (capitalization, punctuation, and digit
|
|
48
|
+
# normalization). Note: Telnyx defaults this to `true`, overriding Deepgram's
|
|
49
|
+
# underlying default of `false` — omit the field to get a smart-formatted
|
|
50
|
+
# transcript, or set it to `false` to receive the raw lowercase transcript without
|
|
51
|
+
# punctuation.
|
|
52
|
+
#
|
|
53
|
+
# @return [Boolean, nil]
|
|
54
|
+
optional :smart_format, Telnyx::Internal::Type::Boolean
|
|
55
|
+
|
|
38
56
|
# @!attribute utterance_end_ms
|
|
39
57
|
# Number of milliseconds of silence to consider an utterance ended. Ranges from 0
|
|
40
58
|
# to 5000 ms.
|
|
@@ -42,7 +60,7 @@ module Telnyx
|
|
|
42
60
|
# @return [Integer, nil]
|
|
43
61
|
optional :utterance_end_ms, Integer
|
|
44
62
|
|
|
45
|
-
# @!method initialize(transcription_engine:, transcription_model:, interim_results: nil, keywords_boosting: nil, language: nil, utterance_end_ms: nil)
|
|
63
|
+
# @!method initialize(transcription_engine:, transcription_model:, hints: nil, interim_results: nil, keywords_boosting: nil, language: nil, smart_format: nil, utterance_end_ms: nil)
|
|
46
64
|
# Some parameter documentations has been truncated, see
|
|
47
65
|
# {Telnyx::Models::Calls::DeepgramNova2Config} for more details.
|
|
48
66
|
#
|
|
@@ -50,12 +68,16 @@ module Telnyx
|
|
|
50
68
|
#
|
|
51
69
|
# @param transcription_model [Symbol, Telnyx::Models::Calls::DeepgramNova2Config::TranscriptionModel]
|
|
52
70
|
#
|
|
71
|
+
# @param hints [Array<String>] Nova-2 keyword biasing without intensifiers. Up to 100 terms to bias recognition
|
|
72
|
+
#
|
|
53
73
|
# @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
|
|
54
74
|
#
|
|
55
75
|
# @param keywords_boosting [Hash{Symbol=>Float}] Keywords and their respective intensifiers (boosting values) to improve transcri
|
|
56
76
|
#
|
|
57
77
|
# @param language [Symbol, Telnyx::Models::Calls::DeepgramNova2Config::Language] Language to use for speech recognition with nova-2 model
|
|
58
78
|
#
|
|
79
|
+
# @param smart_format [Boolean] Enable Deepgram's smart formatting (capitalization, punctuation, and digit norma
|
|
80
|
+
#
|
|
59
81
|
# @param utterance_end_ms [Integer] Number of milliseconds of silence to consider an utterance ended. Ranges from 0
|
|
60
82
|
|
|
61
83
|
# @see Telnyx::Models::Calls::DeepgramNova2Config#transcription_engine
|
|
@@ -21,6 +21,13 @@ module Telnyx
|
|
|
21
21
|
# @return [Boolean, nil]
|
|
22
22
|
optional :interim_results, Telnyx::Internal::Type::Boolean
|
|
23
23
|
|
|
24
|
+
# @!attribute keyterms
|
|
25
|
+
# Nova-3 keyterm prompting. Up to 100 domain-specific terms or brand names to bias
|
|
26
|
+
# recognition toward. Nova-3-only; use `hints` on Nova-2.
|
|
27
|
+
#
|
|
28
|
+
# @return [Array<String>, nil]
|
|
29
|
+
optional :keyterms, Telnyx::Internal::Type::ArrayOf[String]
|
|
30
|
+
|
|
24
31
|
# @!attribute keywords_boosting
|
|
25
32
|
# Keywords and their respective intensifiers (boosting values) to improve
|
|
26
33
|
# transcription accuracy for specific words or phrases. The intensifier should be
|
|
@@ -35,6 +42,16 @@ module Telnyx
|
|
|
35
42
|
# @return [Symbol, Telnyx::Models::Calls::DeepgramNova3Config::Language, nil]
|
|
36
43
|
optional :language, enum: -> { Telnyx::Calls::DeepgramNova3Config::Language }
|
|
37
44
|
|
|
45
|
+
# @!attribute smart_format
|
|
46
|
+
# Enable Deepgram's smart formatting (capitalization, punctuation, and digit
|
|
47
|
+
# normalization). Note: Telnyx defaults this to `true`, overriding Deepgram's
|
|
48
|
+
# underlying default of `false` — omit the field to get a smart-formatted
|
|
49
|
+
# transcript, or set it to `false` to receive the raw lowercase transcript without
|
|
50
|
+
# punctuation.
|
|
51
|
+
#
|
|
52
|
+
# @return [Boolean, nil]
|
|
53
|
+
optional :smart_format, Telnyx::Internal::Type::Boolean
|
|
54
|
+
|
|
38
55
|
# @!attribute utterance_end_ms
|
|
39
56
|
# Number of milliseconds of silence to consider an utterance ended. Ranges from 0
|
|
40
57
|
# to 5000 ms.
|
|
@@ -42,7 +59,7 @@ module Telnyx
|
|
|
42
59
|
# @return [Integer, nil]
|
|
43
60
|
optional :utterance_end_ms, Integer
|
|
44
61
|
|
|
45
|
-
# @!method initialize(transcription_engine:, transcription_model:, interim_results: nil, keywords_boosting: nil, language: nil, utterance_end_ms: nil)
|
|
62
|
+
# @!method initialize(transcription_engine:, transcription_model:, interim_results: nil, keyterms: nil, keywords_boosting: nil, language: nil, smart_format: nil, utterance_end_ms: nil)
|
|
46
63
|
# Some parameter documentations has been truncated, see
|
|
47
64
|
# {Telnyx::Models::Calls::DeepgramNova3Config} for more details.
|
|
48
65
|
#
|
|
@@ -52,10 +69,14 @@ module Telnyx
|
|
|
52
69
|
#
|
|
53
70
|
# @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
|
|
54
71
|
#
|
|
72
|
+
# @param keyterms [Array<String>] Nova-3 keyterm prompting. Up to 100 domain-specific terms or brand names to bias
|
|
73
|
+
#
|
|
55
74
|
# @param keywords_boosting [Hash{Symbol=>Float}] Keywords and their respective intensifiers (boosting values) to improve transcri
|
|
56
75
|
#
|
|
57
76
|
# @param language [Symbol, Telnyx::Models::Calls::DeepgramNova3Config::Language] Language to use for speech recognition with nova-3 model
|
|
58
77
|
#
|
|
78
|
+
# @param smart_format [Boolean] Enable Deepgram's smart formatting (capitalization, punctuation, and digit norma
|
|
79
|
+
#
|
|
59
80
|
# @param utterance_end_ms [Integer] Number of milliseconds of silence to consider an utterance ended. Ranges from 0
|
|
60
81
|
|
|
61
82
|
# @see Telnyx::Models::Calls::DeepgramNova3Config#transcription_engine
|
|
@@ -27,7 +27,7 @@ module Telnyx
|
|
|
27
27
|
|
|
28
28
|
# @!attribute transcription_engine_config
|
|
29
29
|
#
|
|
30
|
-
# @return [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineSonioxConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config, nil]
|
|
30
|
+
# @return [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineSonioxConfig, Telnyx::Models::Calls::TranscriptionEngineParakeetConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config, nil]
|
|
31
31
|
optional :transcription_engine_config,
|
|
32
32
|
union: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig }
|
|
33
33
|
|
|
@@ -49,7 +49,7 @@ module Telnyx
|
|
|
49
49
|
#
|
|
50
50
|
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
|
|
51
51
|
#
|
|
52
|
-
# @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineSonioxConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
|
|
52
|
+
# @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineSonioxConfig, Telnyx::Models::Calls::TranscriptionEngineParakeetConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
|
|
53
53
|
#
|
|
54
54
|
# @param transcription_tracks [String] Indicates which leg of the call will be transcribed. Use `inbound` for the leg t
|
|
55
55
|
|
|
@@ -96,6 +96,8 @@ module Telnyx
|
|
|
96
96
|
|
|
97
97
|
variant :Soniox, -> { Telnyx::Calls::TranscriptionEngineSonioxConfig }
|
|
98
98
|
|
|
99
|
+
variant :Parakeet, -> { Telnyx::Calls::TranscriptionEngineParakeetConfig }
|
|
100
|
+
|
|
99
101
|
variant :A, -> { Telnyx::Calls::TranscriptionEngineAConfig }
|
|
100
102
|
|
|
101
103
|
variant :B, -> { Telnyx::Calls::TranscriptionEngineBConfig }
|
|
@@ -105,7 +107,7 @@ module Telnyx
|
|
|
105
107
|
variant :"deepgram/nova-3", -> { Telnyx::Calls::DeepgramNova3Config }
|
|
106
108
|
|
|
107
109
|
# @!method self.variants
|
|
108
|
-
# @return [Array(Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineSonioxConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config)]
|
|
110
|
+
# @return [Array(Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineSonioxConfig, Telnyx::Models::Calls::TranscriptionEngineParakeetConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config)]
|
|
109
111
|
end
|
|
110
112
|
end
|
|
111
113
|
end
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Dir
|
|
6
|
+
# @see Telnyx::Resources::Dir::VerifyEmail#create
|
|
7
|
+
class EmailVerificationStatusWrapped < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
# Verification state for a DIR's authorizer email.
|
|
10
|
+
#
|
|
11
|
+
# @return [Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data]
|
|
12
|
+
required :data, -> { Telnyx::Dir::EmailVerificationStatusWrapped::Data }
|
|
13
|
+
|
|
14
|
+
# @!method initialize(data:)
|
|
15
|
+
# @param data [Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data] Verification state for a DIR's authorizer email.
|
|
16
|
+
|
|
17
|
+
# @see Telnyx::Models::Dir::EmailVerificationStatusWrapped#data
|
|
18
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
19
|
+
# @!attribute email_verified
|
|
20
|
+
# Whether the DIR's authorizer email has been confirmed.
|
|
21
|
+
#
|
|
22
|
+
# @return [Boolean]
|
|
23
|
+
required :email_verified, Telnyx::Internal::Type::Boolean
|
|
24
|
+
|
|
25
|
+
# @!attribute status
|
|
26
|
+
# `sent` after a code is emailed; `verified` after a successful confirm;
|
|
27
|
+
# `unverified` when no verification is in progress.
|
|
28
|
+
#
|
|
29
|
+
# @return [Symbol, Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::Status]
|
|
30
|
+
required :status, enum: -> { Telnyx::Dir::EmailVerificationStatusWrapped::Data::Status }
|
|
31
|
+
|
|
32
|
+
response_only do
|
|
33
|
+
# @!attribute record_type
|
|
34
|
+
# Always `email_verification`.
|
|
35
|
+
#
|
|
36
|
+
# @return [Symbol, Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::RecordType]
|
|
37
|
+
required :record_type, enum: -> { Telnyx::Dir::EmailVerificationStatusWrapped::Data::RecordType }
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# @!method initialize(email_verified:, record_type:, status:)
|
|
41
|
+
# Some parameter documentations has been truncated, see
|
|
42
|
+
# {Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data} for more details.
|
|
43
|
+
#
|
|
44
|
+
# Verification state for a DIR's authorizer email.
|
|
45
|
+
#
|
|
46
|
+
# @param email_verified [Boolean] Whether the DIR's authorizer email has been confirmed.
|
|
47
|
+
#
|
|
48
|
+
# @param record_type [Symbol, Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::RecordType] Always `email_verification`.
|
|
49
|
+
#
|
|
50
|
+
# @param status [Symbol, Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::Status] `sent` after a code is emailed; `verified` after a successful confirm; `unverifi
|
|
51
|
+
|
|
52
|
+
# Always `email_verification`.
|
|
53
|
+
#
|
|
54
|
+
# @see Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data#record_type
|
|
55
|
+
module RecordType
|
|
56
|
+
extend Telnyx::Internal::Type::Enum
|
|
57
|
+
|
|
58
|
+
EMAIL_VERIFICATION = :email_verification
|
|
59
|
+
|
|
60
|
+
# @!method self.values
|
|
61
|
+
# @return [Array<Symbol>]
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
# `sent` after a code is emailed; `verified` after a successful confirm;
|
|
65
|
+
# `unverified` when no verification is in progress.
|
|
66
|
+
#
|
|
67
|
+
# @see Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data#status
|
|
68
|
+
module Status
|
|
69
|
+
extend Telnyx::Internal::Type::Enum
|
|
70
|
+
|
|
71
|
+
SENT = :sent
|
|
72
|
+
VERIFIED = :verified
|
|
73
|
+
UNVERIFIED = :unverified
|
|
74
|
+
|
|
75
|
+
# @!method self.values
|
|
76
|
+
# @return [Array<Symbol>]
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
end
|