telnyx 4.3.0 → 4.4.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 +17 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +7 -0
- data/lib/telnyx/internal/transport/pooled_net_requester.rb +30 -24
- data/lib/telnyx/internal/type/union.rb +6 -6
- data/lib/telnyx/models/access_ip_address_list_response.rb +3 -32
- data/lib/telnyx/models/access_ip_range_list_response.rb +3 -32
- data/lib/telnyx/models/advanced_order.rb +93 -0
- data/lib/telnyx/models/advanced_order_create_params.rb +2 -87
- data/lib/telnyx/models/advanced_order_update_requirement_group_params.rb +2 -88
- data/lib/telnyx/models/ai/assistants_list.rb +3 -162
- data/lib/telnyx/models/ai/{assistant_create_response.rb → inference_embedding.rb} +2 -2
- data/lib/telnyx/models/call_dial_params.rb +3 -18
- data/lib/telnyx/models/calls/action_start_streaming_params.rb +3 -18
- data/lib/telnyx/models/calls/telnyx_transcription_language.rb +116 -0
- data/lib/telnyx/models/calls/transcription_engine_b_config.rb +3 -114
- data/lib/telnyx/models/calls/transcription_start_request.rb +3 -115
- data/lib/telnyx/models/document_upload_json_params.rb +50 -0
- data/lib/telnyx/models/document_upload_json_response.rb +16 -0
- data/lib/telnyx/models/legacy/reporting/batch_detail_records/batch_csv_pagination_meta.rb +39 -0
- data/lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_list_response.rb +3 -32
- data/lib/telnyx/models/legacy/reporting/batch_detail_records/voice_list_response.rb +3 -32
- data/lib/telnyx/models/legacy/reporting/usage_reports/messaging_list_response.rb +3 -32
- data/lib/telnyx/models/legacy/reporting/usage_reports/standard_pagination_meta.rb +39 -0
- data/lib/telnyx/models/legacy/reporting/usage_reports/voice_list_response.rb +3 -32
- data/lib/telnyx/models/{verify_profile_create_template_response.rb → message_template.rb} +1 -1
- data/lib/telnyx/models/messaging_tollfree/verification/tf_verification_request.rb +3 -19
- data/lib/telnyx/models/messaging_tollfree/verification/toll_free_verification_entity_type.rb +23 -0
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb +3 -21
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_status.rb +3 -21
- data/lib/telnyx/models/oauth_client_list_response.rb +3 -39
- data/lib/telnyx/models/oauth_grant_list_response.rb +3 -39
- data/lib/telnyx/models/pagination_meta_cloudflare_ip_list_sync.rb +33 -0
- data/lib/telnyx/models/pagination_meta_oauth.rb +40 -0
- data/lib/telnyx/models/phone_number_blocks/job.rb +3 -70
- data/lib/telnyx/models/phone_number_blocks/job_error.rb +73 -0
- data/lib/telnyx/models/phone_numbers/phone_numbers_job.rb +3 -70
- data/lib/telnyx/models/report_list_mdrs_response.rb +3 -32
- data/lib/telnyx/models/reports/mdr_usage_report_list_response.rb +3 -32
- data/lib/telnyx/models/reports/pagination_meta_reporting.rb +35 -0
- data/lib/telnyx/models/stream_bidirectional_sampling_rate.rb +19 -0
- data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +140 -0
- data/lib/telnyx/models/verifications/by_phone_number_list_response.rb +3 -32
- data/lib/telnyx/models/verifications/verify_meta.rb +35 -0
- data/lib/telnyx/models/verify_profile_list_response.rb +3 -32
- data/lib/telnyx/models/webhook_unsafe_unwrap_params.rb +14 -0
- data/lib/telnyx/models.rb +16 -0
- data/lib/telnyx/resources/advanced_orders.rb +4 -4
- data/lib/telnyx/resources/ai/assistants/versions.rb +6 -6
- data/lib/telnyx/resources/ai/assistants.rb +6 -6
- data/lib/telnyx/resources/calls/actions.rb +1 -1
- data/lib/telnyx/resources/calls.rb +1 -1
- data/lib/telnyx/resources/documents.rb +33 -1
- data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb +2 -2
- data/lib/telnyx/resources/verify_profiles.rb +4 -4
- data/lib/telnyx/resources/webhooks.rb +8 -0
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +81 -8
- data/rbi/telnyx/client.rbi +6 -0
- data/rbi/telnyx/models/access_ip_address_list_response.rbi +4 -52
- data/rbi/telnyx/models/access_ip_range_list_response.rbi +4 -52
- data/rbi/telnyx/models/advanced_order.rbi +171 -0
- data/rbi/telnyx/models/advanced_order_create_params.rbi +5 -199
- data/rbi/telnyx/models/advanced_order_update_requirement_group_params.rbi +5 -224
- data/rbi/telnyx/models/ai/assistants_list.rbi +3 -278
- data/rbi/telnyx/models/ai/{assistant_clone_response.rbi → inference_embedding.rbi} +2 -5
- data/rbi/telnyx/models/call_dial_params.rbi +4 -58
- data/rbi/telnyx/models/calls/action_start_streaming_params.rbi +4 -58
- data/rbi/telnyx/models/calls/telnyx_transcription_language.rbi +230 -0
- data/rbi/telnyx/models/calls/transcription_engine_b_config.rbi +4 -531
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +4 -530
- data/rbi/telnyx/models/document_upload_json_params.rbi +75 -0
- data/rbi/telnyx/models/document_upload_json_response.rbi +33 -0
- data/rbi/telnyx/models/legacy/reporting/batch_detail_records/batch_csv_pagination_meta.rbi +74 -0
- data/rbi/telnyx/models/legacy/reporting/batch_detail_records/messaging_list_response.rbi +4 -67
- data/rbi/telnyx/models/legacy/reporting/batch_detail_records/voice_list_response.rbi +4 -67
- data/rbi/telnyx/models/legacy/reporting/usage_reports/messaging_list_response.rbi +4 -67
- data/rbi/telnyx/models/legacy/reporting/usage_reports/standard_pagination_meta.rbi +74 -0
- data/rbi/telnyx/models/legacy/reporting/usage_reports/voice_list_response.rbi +4 -67
- data/rbi/telnyx/models/{verify_profile_create_template_response.rbi → message_template.rbi} +2 -5
- data/rbi/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbi +3 -53
- data/rbi/telnyx/models/messaging_tollfree/verification/toll_free_verification_entity_type.rbi +59 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbi +4 -54
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_status.rbi +4 -54
- data/rbi/telnyx/models/oauth_client_list_response.rbi +4 -77
- data/rbi/telnyx/models/oauth_grant_list_response.rbi +4 -77
- data/rbi/telnyx/models/pagination_meta_cloudflare_ip_list_sync.rbi +51 -0
- data/rbi/telnyx/models/pagination_meta_oauth.rbi +73 -0
- data/rbi/telnyx/models/phone_number_blocks/job.rbi +4 -172
- data/rbi/telnyx/models/phone_number_blocks/job_error.rbi +140 -0
- data/rbi/telnyx/models/phone_numbers/phone_numbers_job.rbi +4 -174
- data/rbi/telnyx/models/report_list_mdrs_response.rbi +4 -67
- data/rbi/telnyx/models/reports/mdr_usage_report_list_response.rbi +4 -75
- data/rbi/telnyx/models/reports/pagination_meta_reporting.rbi +70 -0
- data/rbi/telnyx/models/stream_bidirectional_sampling_rate.rbi +33 -0
- data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +85 -0
- data/rbi/telnyx/models/verifications/by_phone_number_list_response.rbi +4 -78
- data/rbi/telnyx/models/verifications/verify_meta.rbi +67 -0
- data/rbi/telnyx/models/verify_profile_list_response.rbi +4 -71
- data/rbi/telnyx/models/webhook_unsafe_unwrap_params.rbi +27 -0
- data/rbi/telnyx/models.rbi +18 -0
- data/rbi/telnyx/resources/advanced_orders.rbi +4 -10
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -3
- data/rbi/telnyx/resources/ai/assistants.rbi +3 -3
- data/rbi/telnyx/resources/calls/actions.rbi +1 -1
- data/rbi/telnyx/resources/calls.rbi +1 -1
- data/rbi/telnyx/resources/documents.rbi +25 -0
- data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi +2 -2
- data/rbi/telnyx/resources/verify_profiles.rbi +2 -2
- data/rbi/telnyx/resources/webhooks.rbi +76 -0
- data/sig/telnyx/client.rbs +3 -0
- data/sig/telnyx/models/access_ip_address_list_response.rbs +4 -36
- data/sig/telnyx/models/access_ip_range_list_response.rbs +4 -36
- data/sig/telnyx/models/advanced_order.rbs +105 -0
- data/sig/telnyx/models/advanced_order_create_params.rbs +4 -100
- data/sig/telnyx/models/advanced_order_update_requirement_group_params.rbs +4 -100
- data/sig/telnyx/models/ai/assistants_list.rbs +4 -159
- data/sig/telnyx/models/ai/{assistant_clone_response.rbs → inference_embedding.rbs} +2 -2
- data/sig/telnyx/models/call_dial_params.rbs +6 -21
- data/sig/telnyx/models/calls/action_start_streaming_params.rbs +6 -21
- data/sig/telnyx/models/calls/telnyx_transcription_language.rbs +214 -0
- data/sig/telnyx/models/calls/transcription_engine_b_config.rbs +6 -215
- data/sig/telnyx/models/calls/transcription_start_request.rbs +6 -215
- data/sig/telnyx/models/document_upload_json_params.rbs +45 -0
- data/sig/telnyx/models/document_upload_json_response.rbs +15 -0
- data/sig/telnyx/models/legacy/reporting/batch_detail_records/batch_csv_pagination_meta.rbs +49 -0
- data/sig/telnyx/models/legacy/reporting/batch_detail_records/messaging_list_response.rbs +6 -46
- data/sig/telnyx/models/legacy/reporting/batch_detail_records/voice_list_response.rbs +6 -46
- data/sig/telnyx/models/legacy/reporting/usage_reports/messaging_list_response.rbs +6 -46
- data/sig/telnyx/models/legacy/reporting/usage_reports/standard_pagination_meta.rbs +49 -0
- data/sig/telnyx/models/legacy/reporting/usage_reports/voice_list_response.rbs +6 -46
- data/sig/telnyx/models/{verify_profile_create_template_response.rbs → message_template.rbs} +2 -2
- data/sig/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbs +4 -23
- data/sig/telnyx/models/messaging_tollfree/verification/toll_free_verification_entity_type.rbs +26 -0
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs +6 -25
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_status.rbs +6 -25
- data/sig/telnyx/models/oauth_client_list_response.rbs +5 -50
- data/sig/telnyx/models/oauth_grant_list_response.rbs +5 -50
- data/sig/telnyx/models/pagination_meta_cloudflare_ip_list_sync.rbs +35 -0
- data/sig/telnyx/models/pagination_meta_oauth.rbs +43 -0
- data/sig/telnyx/models/phone_number_blocks/job.rbs +6 -81
- data/sig/telnyx/models/phone_number_blocks/job_error.rbs +80 -0
- data/sig/telnyx/models/phone_numbers/phone_numbers_job.rbs +6 -81
- data/sig/telnyx/models/report_list_mdrs_response.rbs +6 -46
- data/sig/telnyx/models/reports/mdr_usage_report_list_response.rbs +6 -46
- data/sig/telnyx/models/reports/pagination_meta_reporting.rbs +45 -0
- data/sig/telnyx/models/stream_bidirectional_sampling_rate.rbs +18 -0
- data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +75 -0
- data/sig/telnyx/models/verifications/by_phone_number_list_response.rbs +4 -44
- data/sig/telnyx/models/verifications/verify_meta.rbs +45 -0
- data/sig/telnyx/models/verify_profile_list_response.rbs +4 -44
- data/sig/telnyx/models/webhook_unsafe_unwrap_params.rbs +15 -0
- data/sig/telnyx/models.rbs +16 -0
- data/sig/telnyx/resources/advanced_orders.rbs +4 -4
- data/sig/telnyx/resources/ai/assistants/versions.rbs +3 -3
- data/sig/telnyx/resources/ai/assistants.rbs +3 -3
- data/sig/telnyx/resources/calls/actions.rbs +1 -1
- data/sig/telnyx/resources/calls.rbs +1 -1
- data/sig/telnyx/resources/documents.rbs +8 -0
- data/sig/telnyx/resources/messaging_tollfree/verification/requests.rbs +2 -2
- data/sig/telnyx/resources/verify_profiles.rbs +2 -2
- data/sig/telnyx/resources/webhooks.rbs +67 -0
- metadata +58 -28
- data/lib/telnyx/models/ai/assistant_clone_response.rb +0 -167
- data/lib/telnyx/models/ai/assistant_retrieve_response.rb +0 -167
- data/lib/telnyx/models/ai/assistants/version_promote_response.rb +0 -169
- data/lib/telnyx/models/ai/assistants/version_retrieve_response.rb +0 -169
- data/lib/telnyx/models/ai/assistants/version_update_response.rb +0 -169
- data/lib/telnyx/models/verify_profile_update_template_response.rb +0 -16
- data/rbi/telnyx/models/ai/assistant_create_response.rbi +0 -277
- data/rbi/telnyx/models/ai/assistant_retrieve_response.rbi +0 -277
- data/rbi/telnyx/models/ai/assistants/version_promote_response.rbi +0 -287
- data/rbi/telnyx/models/ai/assistants/version_retrieve_response.rbi +0 -287
- data/rbi/telnyx/models/ai/assistants/version_update_response.rbi +0 -287
- data/rbi/telnyx/models/verify_profile_update_template_response.rbi +0 -37
- data/sig/telnyx/models/ai/assistant_create_response.rbs +0 -158
- data/sig/telnyx/models/ai/assistant_retrieve_response.rbs +0 -158
- data/sig/telnyx/models/ai/assistants/version_promote_response.rbs +0 -160
- data/sig/telnyx/models/ai/assistants/version_retrieve_response.rbs +0 -160
- data/sig/telnyx/models/ai/assistants/version_update_response.rbs +0 -160
- data/sig/telnyx/models/verify_profile_update_template_response.rbs +0 -20
|
@@ -1,287 +0,0 @@
|
|
|
1
|
-
# typed: strong
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module AI
|
|
6
|
-
module Assistants
|
|
7
|
-
class VersionRetrieveResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
-
OrHash =
|
|
9
|
-
T.type_alias do
|
|
10
|
-
T.any(
|
|
11
|
-
Telnyx::Models::AI::Assistants::VersionRetrieveResponse,
|
|
12
|
-
Telnyx::Internal::AnyHash
|
|
13
|
-
)
|
|
14
|
-
end
|
|
15
|
-
|
|
16
|
-
sig { returns(String) }
|
|
17
|
-
attr_accessor :id
|
|
18
|
-
|
|
19
|
-
sig { returns(Time) }
|
|
20
|
-
attr_accessor :created_at
|
|
21
|
-
|
|
22
|
-
# System instructions for the assistant. These may be templated with
|
|
23
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
24
|
-
sig { returns(String) }
|
|
25
|
-
attr_accessor :instructions
|
|
26
|
-
|
|
27
|
-
# ID of the model to use. You can use the
|
|
28
|
-
# [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
|
|
29
|
-
# to see all of your available models,
|
|
30
|
-
sig { returns(String) }
|
|
31
|
-
attr_accessor :model
|
|
32
|
-
|
|
33
|
-
sig { returns(String) }
|
|
34
|
-
attr_accessor :name
|
|
35
|
-
|
|
36
|
-
sig { returns(T.nilable(String)) }
|
|
37
|
-
attr_reader :description
|
|
38
|
-
|
|
39
|
-
sig { params(description: String).void }
|
|
40
|
-
attr_writer :description
|
|
41
|
-
|
|
42
|
-
# Map of dynamic variables and their values
|
|
43
|
-
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
44
|
-
attr_reader :dynamic_variables
|
|
45
|
-
|
|
46
|
-
sig { params(dynamic_variables: T::Hash[Symbol, T.anything]).void }
|
|
47
|
-
attr_writer :dynamic_variables
|
|
48
|
-
|
|
49
|
-
# If the dynamic_variables_webhook_url is set for the assistant, we will send a
|
|
50
|
-
# request at the start of the conversation. See our
|
|
51
|
-
# [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
52
|
-
# for more information.
|
|
53
|
-
sig { returns(T.nilable(String)) }
|
|
54
|
-
attr_reader :dynamic_variables_webhook_url
|
|
55
|
-
|
|
56
|
-
sig { params(dynamic_variables_webhook_url: String).void }
|
|
57
|
-
attr_writer :dynamic_variables_webhook_url
|
|
58
|
-
|
|
59
|
-
sig do
|
|
60
|
-
returns(
|
|
61
|
-
T.nilable(T::Array[Telnyx::AI::EnabledFeatures::TaggedSymbol])
|
|
62
|
-
)
|
|
63
|
-
end
|
|
64
|
-
attr_reader :enabled_features
|
|
65
|
-
|
|
66
|
-
sig do
|
|
67
|
-
params(
|
|
68
|
-
enabled_features: T::Array[Telnyx::AI::EnabledFeatures::OrSymbol]
|
|
69
|
-
).void
|
|
70
|
-
end
|
|
71
|
-
attr_writer :enabled_features
|
|
72
|
-
|
|
73
|
-
# Text that the assistant will use to start the conversation. This may be
|
|
74
|
-
# templated with
|
|
75
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
76
|
-
sig { returns(T.nilable(String)) }
|
|
77
|
-
attr_reader :greeting
|
|
78
|
-
|
|
79
|
-
sig { params(greeting: String).void }
|
|
80
|
-
attr_writer :greeting
|
|
81
|
-
|
|
82
|
-
sig { returns(T.nilable(Telnyx::AI::ImportMetadata)) }
|
|
83
|
-
attr_reader :import_metadata
|
|
84
|
-
|
|
85
|
-
sig do
|
|
86
|
-
params(import_metadata: Telnyx::AI::ImportMetadata::OrHash).void
|
|
87
|
-
end
|
|
88
|
-
attr_writer :import_metadata
|
|
89
|
-
|
|
90
|
-
sig { returns(T.nilable(Telnyx::AI::InsightSettings)) }
|
|
91
|
-
attr_reader :insight_settings
|
|
92
|
-
|
|
93
|
-
sig do
|
|
94
|
-
params(insight_settings: Telnyx::AI::InsightSettings::OrHash).void
|
|
95
|
-
end
|
|
96
|
-
attr_writer :insight_settings
|
|
97
|
-
|
|
98
|
-
# This is only needed when using third-party inference providers. The `identifier`
|
|
99
|
-
# for an integration secret
|
|
100
|
-
# [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
101
|
-
# that refers to your LLM provider's API key. Warning: Free plans are unlikely to
|
|
102
|
-
# work with this integration.
|
|
103
|
-
sig { returns(T.nilable(String)) }
|
|
104
|
-
attr_reader :llm_api_key_ref
|
|
105
|
-
|
|
106
|
-
sig { params(llm_api_key_ref: String).void }
|
|
107
|
-
attr_writer :llm_api_key_ref
|
|
108
|
-
|
|
109
|
-
sig { returns(T.nilable(Telnyx::AI::MessagingSettings)) }
|
|
110
|
-
attr_reader :messaging_settings
|
|
111
|
-
|
|
112
|
-
sig do
|
|
113
|
-
params(
|
|
114
|
-
messaging_settings: Telnyx::AI::MessagingSettings::OrHash
|
|
115
|
-
).void
|
|
116
|
-
end
|
|
117
|
-
attr_writer :messaging_settings
|
|
118
|
-
|
|
119
|
-
sig { returns(T.nilable(Telnyx::AI::PrivacySettings)) }
|
|
120
|
-
attr_reader :privacy_settings
|
|
121
|
-
|
|
122
|
-
sig do
|
|
123
|
-
params(privacy_settings: Telnyx::AI::PrivacySettings::OrHash).void
|
|
124
|
-
end
|
|
125
|
-
attr_writer :privacy_settings
|
|
126
|
-
|
|
127
|
-
sig { returns(T.nilable(Telnyx::AI::TelephonySettings)) }
|
|
128
|
-
attr_reader :telephony_settings
|
|
129
|
-
|
|
130
|
-
sig do
|
|
131
|
-
params(
|
|
132
|
-
telephony_settings: Telnyx::AI::TelephonySettings::OrHash
|
|
133
|
-
).void
|
|
134
|
-
end
|
|
135
|
-
attr_writer :telephony_settings
|
|
136
|
-
|
|
137
|
-
# The tools that the assistant can use. These may be templated with
|
|
138
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
139
|
-
sig do
|
|
140
|
-
returns(T.nilable(T::Array[Telnyx::AI::AssistantTool::Variants]))
|
|
141
|
-
end
|
|
142
|
-
attr_reader :tools
|
|
143
|
-
|
|
144
|
-
sig do
|
|
145
|
-
params(
|
|
146
|
-
tools:
|
|
147
|
-
T::Array[
|
|
148
|
-
T.any(
|
|
149
|
-
Telnyx::AI::WebhookTool::OrHash,
|
|
150
|
-
Telnyx::AI::RetrievalTool::OrHash,
|
|
151
|
-
Telnyx::AI::AssistantTool::HandoffTool::OrHash,
|
|
152
|
-
Telnyx::AI::HangupTool::OrHash,
|
|
153
|
-
Telnyx::AI::TransferTool::OrHash,
|
|
154
|
-
Telnyx::AI::AssistantTool::SipReferTool::OrHash,
|
|
155
|
-
Telnyx::AI::AssistantTool::DtmfTool::OrHash
|
|
156
|
-
)
|
|
157
|
-
]
|
|
158
|
-
).void
|
|
159
|
-
end
|
|
160
|
-
attr_writer :tools
|
|
161
|
-
|
|
162
|
-
sig { returns(T.nilable(Telnyx::AI::TranscriptionSettings)) }
|
|
163
|
-
attr_reader :transcription
|
|
164
|
-
|
|
165
|
-
sig do
|
|
166
|
-
params(
|
|
167
|
-
transcription: Telnyx::AI::TranscriptionSettings::OrHash
|
|
168
|
-
).void
|
|
169
|
-
end
|
|
170
|
-
attr_writer :transcription
|
|
171
|
-
|
|
172
|
-
sig { returns(T.nilable(Telnyx::AI::VoiceSettings)) }
|
|
173
|
-
attr_reader :voice_settings
|
|
174
|
-
|
|
175
|
-
sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
|
|
176
|
-
attr_writer :voice_settings
|
|
177
|
-
|
|
178
|
-
sig do
|
|
179
|
-
params(
|
|
180
|
-
id: String,
|
|
181
|
-
created_at: Time,
|
|
182
|
-
instructions: String,
|
|
183
|
-
model: String,
|
|
184
|
-
name: String,
|
|
185
|
-
description: String,
|
|
186
|
-
dynamic_variables: T::Hash[Symbol, T.anything],
|
|
187
|
-
dynamic_variables_webhook_url: String,
|
|
188
|
-
enabled_features: T::Array[Telnyx::AI::EnabledFeatures::OrSymbol],
|
|
189
|
-
greeting: String,
|
|
190
|
-
import_metadata: Telnyx::AI::ImportMetadata::OrHash,
|
|
191
|
-
insight_settings: Telnyx::AI::InsightSettings::OrHash,
|
|
192
|
-
llm_api_key_ref: String,
|
|
193
|
-
messaging_settings: Telnyx::AI::MessagingSettings::OrHash,
|
|
194
|
-
privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
|
|
195
|
-
telephony_settings: Telnyx::AI::TelephonySettings::OrHash,
|
|
196
|
-
tools:
|
|
197
|
-
T::Array[
|
|
198
|
-
T.any(
|
|
199
|
-
Telnyx::AI::WebhookTool::OrHash,
|
|
200
|
-
Telnyx::AI::RetrievalTool::OrHash,
|
|
201
|
-
Telnyx::AI::AssistantTool::HandoffTool::OrHash,
|
|
202
|
-
Telnyx::AI::HangupTool::OrHash,
|
|
203
|
-
Telnyx::AI::TransferTool::OrHash,
|
|
204
|
-
Telnyx::AI::AssistantTool::SipReferTool::OrHash,
|
|
205
|
-
Telnyx::AI::AssistantTool::DtmfTool::OrHash
|
|
206
|
-
)
|
|
207
|
-
],
|
|
208
|
-
transcription: Telnyx::AI::TranscriptionSettings::OrHash,
|
|
209
|
-
voice_settings: Telnyx::AI::VoiceSettings::OrHash
|
|
210
|
-
).returns(T.attached_class)
|
|
211
|
-
end
|
|
212
|
-
def self.new(
|
|
213
|
-
id:,
|
|
214
|
-
created_at:,
|
|
215
|
-
# System instructions for the assistant. These may be templated with
|
|
216
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
217
|
-
instructions:,
|
|
218
|
-
# ID of the model to use. You can use the
|
|
219
|
-
# [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
|
|
220
|
-
# to see all of your available models,
|
|
221
|
-
model:,
|
|
222
|
-
name:,
|
|
223
|
-
description: nil,
|
|
224
|
-
# Map of dynamic variables and their values
|
|
225
|
-
dynamic_variables: nil,
|
|
226
|
-
# If the dynamic_variables_webhook_url is set for the assistant, we will send a
|
|
227
|
-
# request at the start of the conversation. See our
|
|
228
|
-
# [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
229
|
-
# for more information.
|
|
230
|
-
dynamic_variables_webhook_url: nil,
|
|
231
|
-
enabled_features: nil,
|
|
232
|
-
# Text that the assistant will use to start the conversation. This may be
|
|
233
|
-
# templated with
|
|
234
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
235
|
-
greeting: nil,
|
|
236
|
-
import_metadata: nil,
|
|
237
|
-
insight_settings: nil,
|
|
238
|
-
# This is only needed when using third-party inference providers. The `identifier`
|
|
239
|
-
# for an integration secret
|
|
240
|
-
# [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
241
|
-
# that refers to your LLM provider's API key. Warning: Free plans are unlikely to
|
|
242
|
-
# work with this integration.
|
|
243
|
-
llm_api_key_ref: nil,
|
|
244
|
-
messaging_settings: nil,
|
|
245
|
-
privacy_settings: nil,
|
|
246
|
-
telephony_settings: nil,
|
|
247
|
-
# The tools that the assistant can use. These may be templated with
|
|
248
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
249
|
-
tools: nil,
|
|
250
|
-
transcription: nil,
|
|
251
|
-
voice_settings: nil
|
|
252
|
-
)
|
|
253
|
-
end
|
|
254
|
-
|
|
255
|
-
sig do
|
|
256
|
-
override.returns(
|
|
257
|
-
{
|
|
258
|
-
id: String,
|
|
259
|
-
created_at: Time,
|
|
260
|
-
instructions: String,
|
|
261
|
-
model: String,
|
|
262
|
-
name: String,
|
|
263
|
-
description: String,
|
|
264
|
-
dynamic_variables: T::Hash[Symbol, T.anything],
|
|
265
|
-
dynamic_variables_webhook_url: String,
|
|
266
|
-
enabled_features:
|
|
267
|
-
T::Array[Telnyx::AI::EnabledFeatures::TaggedSymbol],
|
|
268
|
-
greeting: String,
|
|
269
|
-
import_metadata: Telnyx::AI::ImportMetadata,
|
|
270
|
-
insight_settings: Telnyx::AI::InsightSettings,
|
|
271
|
-
llm_api_key_ref: String,
|
|
272
|
-
messaging_settings: Telnyx::AI::MessagingSettings,
|
|
273
|
-
privacy_settings: Telnyx::AI::PrivacySettings,
|
|
274
|
-
telephony_settings: Telnyx::AI::TelephonySettings,
|
|
275
|
-
tools: T::Array[Telnyx::AI::AssistantTool::Variants],
|
|
276
|
-
transcription: Telnyx::AI::TranscriptionSettings,
|
|
277
|
-
voice_settings: Telnyx::AI::VoiceSettings
|
|
278
|
-
}
|
|
279
|
-
)
|
|
280
|
-
end
|
|
281
|
-
def to_hash
|
|
282
|
-
end
|
|
283
|
-
end
|
|
284
|
-
end
|
|
285
|
-
end
|
|
286
|
-
end
|
|
287
|
-
end
|
|
@@ -1,287 +0,0 @@
|
|
|
1
|
-
# typed: strong
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module AI
|
|
6
|
-
module Assistants
|
|
7
|
-
class VersionUpdateResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
-
OrHash =
|
|
9
|
-
T.type_alias do
|
|
10
|
-
T.any(
|
|
11
|
-
Telnyx::Models::AI::Assistants::VersionUpdateResponse,
|
|
12
|
-
Telnyx::Internal::AnyHash
|
|
13
|
-
)
|
|
14
|
-
end
|
|
15
|
-
|
|
16
|
-
sig { returns(String) }
|
|
17
|
-
attr_accessor :id
|
|
18
|
-
|
|
19
|
-
sig { returns(Time) }
|
|
20
|
-
attr_accessor :created_at
|
|
21
|
-
|
|
22
|
-
# System instructions for the assistant. These may be templated with
|
|
23
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
24
|
-
sig { returns(String) }
|
|
25
|
-
attr_accessor :instructions
|
|
26
|
-
|
|
27
|
-
# ID of the model to use. You can use the
|
|
28
|
-
# [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
|
|
29
|
-
# to see all of your available models,
|
|
30
|
-
sig { returns(String) }
|
|
31
|
-
attr_accessor :model
|
|
32
|
-
|
|
33
|
-
sig { returns(String) }
|
|
34
|
-
attr_accessor :name
|
|
35
|
-
|
|
36
|
-
sig { returns(T.nilable(String)) }
|
|
37
|
-
attr_reader :description
|
|
38
|
-
|
|
39
|
-
sig { params(description: String).void }
|
|
40
|
-
attr_writer :description
|
|
41
|
-
|
|
42
|
-
# Map of dynamic variables and their values
|
|
43
|
-
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
44
|
-
attr_reader :dynamic_variables
|
|
45
|
-
|
|
46
|
-
sig { params(dynamic_variables: T::Hash[Symbol, T.anything]).void }
|
|
47
|
-
attr_writer :dynamic_variables
|
|
48
|
-
|
|
49
|
-
# If the dynamic_variables_webhook_url is set for the assistant, we will send a
|
|
50
|
-
# request at the start of the conversation. See our
|
|
51
|
-
# [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
52
|
-
# for more information.
|
|
53
|
-
sig { returns(T.nilable(String)) }
|
|
54
|
-
attr_reader :dynamic_variables_webhook_url
|
|
55
|
-
|
|
56
|
-
sig { params(dynamic_variables_webhook_url: String).void }
|
|
57
|
-
attr_writer :dynamic_variables_webhook_url
|
|
58
|
-
|
|
59
|
-
sig do
|
|
60
|
-
returns(
|
|
61
|
-
T.nilable(T::Array[Telnyx::AI::EnabledFeatures::TaggedSymbol])
|
|
62
|
-
)
|
|
63
|
-
end
|
|
64
|
-
attr_reader :enabled_features
|
|
65
|
-
|
|
66
|
-
sig do
|
|
67
|
-
params(
|
|
68
|
-
enabled_features: T::Array[Telnyx::AI::EnabledFeatures::OrSymbol]
|
|
69
|
-
).void
|
|
70
|
-
end
|
|
71
|
-
attr_writer :enabled_features
|
|
72
|
-
|
|
73
|
-
# Text that the assistant will use to start the conversation. This may be
|
|
74
|
-
# templated with
|
|
75
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
76
|
-
sig { returns(T.nilable(String)) }
|
|
77
|
-
attr_reader :greeting
|
|
78
|
-
|
|
79
|
-
sig { params(greeting: String).void }
|
|
80
|
-
attr_writer :greeting
|
|
81
|
-
|
|
82
|
-
sig { returns(T.nilable(Telnyx::AI::ImportMetadata)) }
|
|
83
|
-
attr_reader :import_metadata
|
|
84
|
-
|
|
85
|
-
sig do
|
|
86
|
-
params(import_metadata: Telnyx::AI::ImportMetadata::OrHash).void
|
|
87
|
-
end
|
|
88
|
-
attr_writer :import_metadata
|
|
89
|
-
|
|
90
|
-
sig { returns(T.nilable(Telnyx::AI::InsightSettings)) }
|
|
91
|
-
attr_reader :insight_settings
|
|
92
|
-
|
|
93
|
-
sig do
|
|
94
|
-
params(insight_settings: Telnyx::AI::InsightSettings::OrHash).void
|
|
95
|
-
end
|
|
96
|
-
attr_writer :insight_settings
|
|
97
|
-
|
|
98
|
-
# This is only needed when using third-party inference providers. The `identifier`
|
|
99
|
-
# for an integration secret
|
|
100
|
-
# [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
101
|
-
# that refers to your LLM provider's API key. Warning: Free plans are unlikely to
|
|
102
|
-
# work with this integration.
|
|
103
|
-
sig { returns(T.nilable(String)) }
|
|
104
|
-
attr_reader :llm_api_key_ref
|
|
105
|
-
|
|
106
|
-
sig { params(llm_api_key_ref: String).void }
|
|
107
|
-
attr_writer :llm_api_key_ref
|
|
108
|
-
|
|
109
|
-
sig { returns(T.nilable(Telnyx::AI::MessagingSettings)) }
|
|
110
|
-
attr_reader :messaging_settings
|
|
111
|
-
|
|
112
|
-
sig do
|
|
113
|
-
params(
|
|
114
|
-
messaging_settings: Telnyx::AI::MessagingSettings::OrHash
|
|
115
|
-
).void
|
|
116
|
-
end
|
|
117
|
-
attr_writer :messaging_settings
|
|
118
|
-
|
|
119
|
-
sig { returns(T.nilable(Telnyx::AI::PrivacySettings)) }
|
|
120
|
-
attr_reader :privacy_settings
|
|
121
|
-
|
|
122
|
-
sig do
|
|
123
|
-
params(privacy_settings: Telnyx::AI::PrivacySettings::OrHash).void
|
|
124
|
-
end
|
|
125
|
-
attr_writer :privacy_settings
|
|
126
|
-
|
|
127
|
-
sig { returns(T.nilable(Telnyx::AI::TelephonySettings)) }
|
|
128
|
-
attr_reader :telephony_settings
|
|
129
|
-
|
|
130
|
-
sig do
|
|
131
|
-
params(
|
|
132
|
-
telephony_settings: Telnyx::AI::TelephonySettings::OrHash
|
|
133
|
-
).void
|
|
134
|
-
end
|
|
135
|
-
attr_writer :telephony_settings
|
|
136
|
-
|
|
137
|
-
# The tools that the assistant can use. These may be templated with
|
|
138
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
139
|
-
sig do
|
|
140
|
-
returns(T.nilable(T::Array[Telnyx::AI::AssistantTool::Variants]))
|
|
141
|
-
end
|
|
142
|
-
attr_reader :tools
|
|
143
|
-
|
|
144
|
-
sig do
|
|
145
|
-
params(
|
|
146
|
-
tools:
|
|
147
|
-
T::Array[
|
|
148
|
-
T.any(
|
|
149
|
-
Telnyx::AI::WebhookTool::OrHash,
|
|
150
|
-
Telnyx::AI::RetrievalTool::OrHash,
|
|
151
|
-
Telnyx::AI::AssistantTool::HandoffTool::OrHash,
|
|
152
|
-
Telnyx::AI::HangupTool::OrHash,
|
|
153
|
-
Telnyx::AI::TransferTool::OrHash,
|
|
154
|
-
Telnyx::AI::AssistantTool::SipReferTool::OrHash,
|
|
155
|
-
Telnyx::AI::AssistantTool::DtmfTool::OrHash
|
|
156
|
-
)
|
|
157
|
-
]
|
|
158
|
-
).void
|
|
159
|
-
end
|
|
160
|
-
attr_writer :tools
|
|
161
|
-
|
|
162
|
-
sig { returns(T.nilable(Telnyx::AI::TranscriptionSettings)) }
|
|
163
|
-
attr_reader :transcription
|
|
164
|
-
|
|
165
|
-
sig do
|
|
166
|
-
params(
|
|
167
|
-
transcription: Telnyx::AI::TranscriptionSettings::OrHash
|
|
168
|
-
).void
|
|
169
|
-
end
|
|
170
|
-
attr_writer :transcription
|
|
171
|
-
|
|
172
|
-
sig { returns(T.nilable(Telnyx::AI::VoiceSettings)) }
|
|
173
|
-
attr_reader :voice_settings
|
|
174
|
-
|
|
175
|
-
sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
|
|
176
|
-
attr_writer :voice_settings
|
|
177
|
-
|
|
178
|
-
sig do
|
|
179
|
-
params(
|
|
180
|
-
id: String,
|
|
181
|
-
created_at: Time,
|
|
182
|
-
instructions: String,
|
|
183
|
-
model: String,
|
|
184
|
-
name: String,
|
|
185
|
-
description: String,
|
|
186
|
-
dynamic_variables: T::Hash[Symbol, T.anything],
|
|
187
|
-
dynamic_variables_webhook_url: String,
|
|
188
|
-
enabled_features: T::Array[Telnyx::AI::EnabledFeatures::OrSymbol],
|
|
189
|
-
greeting: String,
|
|
190
|
-
import_metadata: Telnyx::AI::ImportMetadata::OrHash,
|
|
191
|
-
insight_settings: Telnyx::AI::InsightSettings::OrHash,
|
|
192
|
-
llm_api_key_ref: String,
|
|
193
|
-
messaging_settings: Telnyx::AI::MessagingSettings::OrHash,
|
|
194
|
-
privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
|
|
195
|
-
telephony_settings: Telnyx::AI::TelephonySettings::OrHash,
|
|
196
|
-
tools:
|
|
197
|
-
T::Array[
|
|
198
|
-
T.any(
|
|
199
|
-
Telnyx::AI::WebhookTool::OrHash,
|
|
200
|
-
Telnyx::AI::RetrievalTool::OrHash,
|
|
201
|
-
Telnyx::AI::AssistantTool::HandoffTool::OrHash,
|
|
202
|
-
Telnyx::AI::HangupTool::OrHash,
|
|
203
|
-
Telnyx::AI::TransferTool::OrHash,
|
|
204
|
-
Telnyx::AI::AssistantTool::SipReferTool::OrHash,
|
|
205
|
-
Telnyx::AI::AssistantTool::DtmfTool::OrHash
|
|
206
|
-
)
|
|
207
|
-
],
|
|
208
|
-
transcription: Telnyx::AI::TranscriptionSettings::OrHash,
|
|
209
|
-
voice_settings: Telnyx::AI::VoiceSettings::OrHash
|
|
210
|
-
).returns(T.attached_class)
|
|
211
|
-
end
|
|
212
|
-
def self.new(
|
|
213
|
-
id:,
|
|
214
|
-
created_at:,
|
|
215
|
-
# System instructions for the assistant. These may be templated with
|
|
216
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
217
|
-
instructions:,
|
|
218
|
-
# ID of the model to use. You can use the
|
|
219
|
-
# [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
|
|
220
|
-
# to see all of your available models,
|
|
221
|
-
model:,
|
|
222
|
-
name:,
|
|
223
|
-
description: nil,
|
|
224
|
-
# Map of dynamic variables and their values
|
|
225
|
-
dynamic_variables: nil,
|
|
226
|
-
# If the dynamic_variables_webhook_url is set for the assistant, we will send a
|
|
227
|
-
# request at the start of the conversation. See our
|
|
228
|
-
# [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
229
|
-
# for more information.
|
|
230
|
-
dynamic_variables_webhook_url: nil,
|
|
231
|
-
enabled_features: nil,
|
|
232
|
-
# Text that the assistant will use to start the conversation. This may be
|
|
233
|
-
# templated with
|
|
234
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
235
|
-
greeting: nil,
|
|
236
|
-
import_metadata: nil,
|
|
237
|
-
insight_settings: nil,
|
|
238
|
-
# This is only needed when using third-party inference providers. The `identifier`
|
|
239
|
-
# for an integration secret
|
|
240
|
-
# [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
241
|
-
# that refers to your LLM provider's API key. Warning: Free plans are unlikely to
|
|
242
|
-
# work with this integration.
|
|
243
|
-
llm_api_key_ref: nil,
|
|
244
|
-
messaging_settings: nil,
|
|
245
|
-
privacy_settings: nil,
|
|
246
|
-
telephony_settings: nil,
|
|
247
|
-
# The tools that the assistant can use. These may be templated with
|
|
248
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
249
|
-
tools: nil,
|
|
250
|
-
transcription: nil,
|
|
251
|
-
voice_settings: nil
|
|
252
|
-
)
|
|
253
|
-
end
|
|
254
|
-
|
|
255
|
-
sig do
|
|
256
|
-
override.returns(
|
|
257
|
-
{
|
|
258
|
-
id: String,
|
|
259
|
-
created_at: Time,
|
|
260
|
-
instructions: String,
|
|
261
|
-
model: String,
|
|
262
|
-
name: String,
|
|
263
|
-
description: String,
|
|
264
|
-
dynamic_variables: T::Hash[Symbol, T.anything],
|
|
265
|
-
dynamic_variables_webhook_url: String,
|
|
266
|
-
enabled_features:
|
|
267
|
-
T::Array[Telnyx::AI::EnabledFeatures::TaggedSymbol],
|
|
268
|
-
greeting: String,
|
|
269
|
-
import_metadata: Telnyx::AI::ImportMetadata,
|
|
270
|
-
insight_settings: Telnyx::AI::InsightSettings,
|
|
271
|
-
llm_api_key_ref: String,
|
|
272
|
-
messaging_settings: Telnyx::AI::MessagingSettings,
|
|
273
|
-
privacy_settings: Telnyx::AI::PrivacySettings,
|
|
274
|
-
telephony_settings: Telnyx::AI::TelephonySettings,
|
|
275
|
-
tools: T::Array[Telnyx::AI::AssistantTool::Variants],
|
|
276
|
-
transcription: Telnyx::AI::TranscriptionSettings,
|
|
277
|
-
voice_settings: Telnyx::AI::VoiceSettings
|
|
278
|
-
}
|
|
279
|
-
)
|
|
280
|
-
end
|
|
281
|
-
def to_hash
|
|
282
|
-
end
|
|
283
|
-
end
|
|
284
|
-
end
|
|
285
|
-
end
|
|
286
|
-
end
|
|
287
|
-
end
|
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
# typed: strong
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
class VerifyProfileUpdateTemplateResponse < Telnyx::Internal::Type::BaseModel
|
|
6
|
-
OrHash =
|
|
7
|
-
T.type_alias do
|
|
8
|
-
T.any(
|
|
9
|
-
Telnyx::Models::VerifyProfileUpdateTemplateResponse,
|
|
10
|
-
Telnyx::Internal::AnyHash
|
|
11
|
-
)
|
|
12
|
-
end
|
|
13
|
-
|
|
14
|
-
sig { returns(T.nilable(Telnyx::VerifyProfileMessageTemplateResponse)) }
|
|
15
|
-
attr_reader :data
|
|
16
|
-
|
|
17
|
-
sig do
|
|
18
|
-
params(data: Telnyx::VerifyProfileMessageTemplateResponse::OrHash).void
|
|
19
|
-
end
|
|
20
|
-
attr_writer :data
|
|
21
|
-
|
|
22
|
-
sig do
|
|
23
|
-
params(
|
|
24
|
-
data: Telnyx::VerifyProfileMessageTemplateResponse::OrHash
|
|
25
|
-
).returns(T.attached_class)
|
|
26
|
-
end
|
|
27
|
-
def self.new(data: nil)
|
|
28
|
-
end
|
|
29
|
-
|
|
30
|
-
sig do
|
|
31
|
-
override.returns({ data: Telnyx::VerifyProfileMessageTemplateResponse })
|
|
32
|
-
end
|
|
33
|
-
def to_hash
|
|
34
|
-
end
|
|
35
|
-
end
|
|
36
|
-
end
|
|
37
|
-
end
|