telnyx 5.1.0 → 5.2.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 +8 -0
- data/README.md +1 -1
- data/lib/telnyx/models/ai/assistant_create_params.rb +3 -173
- data/lib/telnyx/models/ai/assistant_update_params.rb +3 -173
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +3 -175
- data/lib/telnyx/models/ai/audio_visualizer_config.rb +43 -0
- data/lib/telnyx/models/ai/inference_embedding.rb +3 -173
- data/lib/telnyx/models/ai/widget_settings.rb +138 -0
- data/lib/telnyx/models/connection_noise_suppression_details.rb +61 -0
- data/lib/telnyx/models/credential_connection.rb +3 -61
- data/lib/telnyx/models/credential_connection_create_params.rb +3 -61
- data/lib/telnyx/models/credential_connection_update_params.rb +3 -61
- data/lib/telnyx/models/fqdn_connection.rb +3 -60
- data/lib/telnyx/models/fqdn_connection_create_params.rb +3 -60
- data/lib/telnyx/models/fqdn_connection_update_params.rb +3 -60
- data/lib/telnyx/models/ip_connection.rb +3 -60
- data/lib/telnyx/models/ip_connection_create_params.rb +3 -60
- data/lib/telnyx/models/ip_connection_update_params.rb +3 -60
- data/lib/telnyx/models/organizations/user_get_groups_report_response.rb +3 -25
- data/lib/telnyx/models/organizations/user_group_reference.rb +28 -0
- data/lib/telnyx/models/organizations/user_list_response.rb +3 -25
- data/lib/telnyx/models/organizations/user_retrieve_response.rb +3 -25
- data/lib/telnyx/models/organizations/users/action_remove_response.rb +3 -25
- data/lib/telnyx/models.rb +2 -0
- data/lib/telnyx/resources/ai/assistants/versions.rb +1 -1
- data/lib/telnyx/resources/ai/assistants.rb +2 -2
- data/lib/telnyx/resources/credential_connections.rb +2 -2
- data/lib/telnyx/resources/fqdn_connections.rb +2 -2
- data/lib/telnyx/resources/ip_connections.rb +2 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +4 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +4 -422
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +4 -422
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +4 -422
- data/rbi/telnyx/models/ai/audio_visualizer_config.rbi +107 -0
- data/rbi/telnyx/models/ai/inference_embedding.rbi +4 -421
- data/rbi/telnyx/models/ai/widget_settings.rbi +225 -0
- data/rbi/telnyx/models/connection_noise_suppression_details.rbi +141 -0
- data/rbi/telnyx/models/credential_connection.rbi +4 -152
- data/rbi/telnyx/models/credential_connection_create_params.rbi +4 -154
- data/rbi/telnyx/models/credential_connection_update_params.rbi +4 -154
- data/rbi/telnyx/models/fqdn_connection.rbi +4 -150
- data/rbi/telnyx/models/fqdn_connection_create_params.rbi +4 -152
- data/rbi/telnyx/models/fqdn_connection_update_params.rbi +4 -152
- data/rbi/telnyx/models/ip_connection.rbi +4 -148
- data/rbi/telnyx/models/ip_connection_create_params.rbi +4 -152
- data/rbi/telnyx/models/ip_connection_update_params.rbi +4 -152
- data/rbi/telnyx/models/organizations/user_get_groups_report_response.rbi +3 -46
- data/rbi/telnyx/models/organizations/user_group_reference.rbi +39 -0
- data/rbi/telnyx/models/organizations/user_list_response.rbi +4 -47
- data/rbi/telnyx/models/organizations/user_retrieve_response.rbi +4 -47
- data/rbi/telnyx/models/organizations/users/action_remove_response.rbi +4 -47
- data/rbi/telnyx/models.rbi +3 -0
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +1 -2
- data/rbi/telnyx/resources/ai/assistants.rbi +2 -4
- data/rbi/telnyx/resources/credential_connections.rbi +2 -2
- data/rbi/telnyx/resources/fqdn_connections.rbi +2 -2
- data/rbi/telnyx/resources/ip_connections.rbi +2 -2
- data/sig/telnyx/models/ai/assistant_create_params.rbs +6 -172
- data/sig/telnyx/models/ai/assistant_update_params.rbs +6 -172
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +6 -172
- data/sig/telnyx/models/ai/audio_visualizer_config.rbs +48 -0
- data/sig/telnyx/models/ai/inference_embedding.rbs +6 -172
- data/sig/telnyx/models/ai/widget_settings.rbs +127 -0
- data/sig/telnyx/models/connection_noise_suppression_details.rbs +54 -0
- data/sig/telnyx/models/credential_connection.rbs +6 -57
- data/sig/telnyx/models/credential_connection_create_params.rbs +6 -57
- data/sig/telnyx/models/credential_connection_update_params.rbs +6 -57
- data/sig/telnyx/models/fqdn_connection.rbs +6 -57
- data/sig/telnyx/models/fqdn_connection_create_params.rbs +6 -57
- data/sig/telnyx/models/fqdn_connection_update_params.rbs +6 -57
- data/sig/telnyx/models/ip_connection.rbs +6 -57
- data/sig/telnyx/models/ip_connection_create_params.rbs +6 -57
- data/sig/telnyx/models/ip_connection_update_params.rbs +6 -57
- data/sig/telnyx/models/organizations/user_get_groups_report_response.rbs +4 -16
- data/sig/telnyx/models/organizations/user_group_reference.rbs +17 -0
- data/sig/telnyx/models/organizations/user_list_response.rbs +6 -18
- data/sig/telnyx/models/organizations/user_retrieve_response.rbs +6 -18
- data/sig/telnyx/models/organizations/users/action_remove_response.rbs +6 -18
- data/sig/telnyx/models.rbs +2 -0
- data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -1
- data/sig/telnyx/resources/ai/assistants.rbs +2 -2
- data/sig/telnyx/resources/credential_connections.rbs +2 -2
- data/sig/telnyx/resources/fqdn_connections.rbs +2 -2
- data/sig/telnyx/resources/ip_connections.rbs +2 -2
- metadata +13 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1d7930fc7b48b6545e1871b9931bcb1fce7661f52b8ba959f19871be335d75a4
|
|
4
|
+
data.tar.gz: 6d62bbab0f6da6c323c9a46d66eaf3781275d145332121fbe1c99fd5ab64c84b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9d7d007e45900de8273dec5b5e9ee215fcacfc551ec2564b425c8c942d3cc8149de5a0253159dc2917d99f0cc1f15ab702faf4906acf047d5a3b2eed00cffe95
|
|
7
|
+
data.tar.gz: 4bebdbccc0fc17cf8bbf38c84900312b1cd0598d19cd8caa5cb2d4da7754eaec910e3bb459552e2eee76a87166ae8ad3c40132fa6c3b2524c8dd503d62a5317d
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 5.2.0 (2026-01-22)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v5.1.0...v5.2.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.1.0...v5.2.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** manual updates ([03e0903](https://github.com/team-telnyx/telnyx-ruby/commit/03e0903a5ee879e38eebd81885956728a4506a84))
|
|
10
|
+
|
|
3
11
|
## 5.1.0 (2026-01-22)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v5.0.0...v5.1.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.0.0...v5.1.0)
|
data/README.md
CHANGED
|
@@ -114,8 +114,8 @@ module Telnyx
|
|
|
114
114
|
# @!attribute widget_settings
|
|
115
115
|
# Configuration settings for the assistant's web widget.
|
|
116
116
|
#
|
|
117
|
-
# @return [Telnyx::Models::AI::
|
|
118
|
-
optional :widget_settings, -> { Telnyx::AI::
|
|
117
|
+
# @return [Telnyx::Models::AI::WidgetSettings, nil]
|
|
118
|
+
optional :widget_settings, -> { Telnyx::AI::WidgetSettings }
|
|
119
119
|
|
|
120
120
|
# @!method initialize(instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, privacy_settings: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
|
|
121
121
|
# Some parameter documentations has been truncated, see
|
|
@@ -153,179 +153,9 @@ module Telnyx
|
|
|
153
153
|
#
|
|
154
154
|
# @param voice_settings [Telnyx::Models::AI::VoiceSettings]
|
|
155
155
|
#
|
|
156
|
-
# @param widget_settings [Telnyx::Models::AI::
|
|
156
|
+
# @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
|
|
157
157
|
#
|
|
158
158
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
159
|
-
|
|
160
|
-
class WidgetSettings < Telnyx::Internal::Type::BaseModel
|
|
161
|
-
# @!attribute agent_thinking_text
|
|
162
|
-
# Text displayed while the agent is processing.
|
|
163
|
-
#
|
|
164
|
-
# @return [String, nil]
|
|
165
|
-
optional :agent_thinking_text, String
|
|
166
|
-
|
|
167
|
-
# @!attribute audio_visualizer_config
|
|
168
|
-
#
|
|
169
|
-
# @return [Telnyx::Models::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig, nil]
|
|
170
|
-
optional :audio_visualizer_config,
|
|
171
|
-
-> { Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig }
|
|
172
|
-
|
|
173
|
-
# @!attribute default_state
|
|
174
|
-
# The default state of the widget.
|
|
175
|
-
#
|
|
176
|
-
# @return [Symbol, Telnyx::Models::AI::AssistantCreateParams::WidgetSettings::DefaultState, nil]
|
|
177
|
-
optional :default_state, enum: -> { Telnyx::AI::AssistantCreateParams::WidgetSettings::DefaultState }
|
|
178
|
-
|
|
179
|
-
# @!attribute give_feedback_url
|
|
180
|
-
# URL for users to give feedback.
|
|
181
|
-
#
|
|
182
|
-
# @return [String, nil]
|
|
183
|
-
optional :give_feedback_url, String, nil?: true
|
|
184
|
-
|
|
185
|
-
# @!attribute logo_icon_url
|
|
186
|
-
# URL to a custom logo icon for the widget.
|
|
187
|
-
#
|
|
188
|
-
# @return [String, nil]
|
|
189
|
-
optional :logo_icon_url, String, nil?: true
|
|
190
|
-
|
|
191
|
-
# @!attribute position
|
|
192
|
-
# The positioning style for the widget.
|
|
193
|
-
#
|
|
194
|
-
# @return [Symbol, Telnyx::Models::AI::AssistantCreateParams::WidgetSettings::Position, nil]
|
|
195
|
-
optional :position, enum: -> { Telnyx::AI::AssistantCreateParams::WidgetSettings::Position }
|
|
196
|
-
|
|
197
|
-
# @!attribute report_issue_url
|
|
198
|
-
# URL for users to report issues.
|
|
199
|
-
#
|
|
200
|
-
# @return [String, nil]
|
|
201
|
-
optional :report_issue_url, String, nil?: true
|
|
202
|
-
|
|
203
|
-
# @!attribute speak_to_interrupt_text
|
|
204
|
-
# Text prompting users to speak to interrupt.
|
|
205
|
-
#
|
|
206
|
-
# @return [String, nil]
|
|
207
|
-
optional :speak_to_interrupt_text, String
|
|
208
|
-
|
|
209
|
-
# @!attribute start_call_text
|
|
210
|
-
# Custom text displayed on the start call button.
|
|
211
|
-
#
|
|
212
|
-
# @return [String, nil]
|
|
213
|
-
optional :start_call_text, String
|
|
214
|
-
|
|
215
|
-
# @!attribute theme
|
|
216
|
-
# The visual theme for the widget.
|
|
217
|
-
#
|
|
218
|
-
# @return [Symbol, Telnyx::Models::AI::AssistantCreateParams::WidgetSettings::Theme, nil]
|
|
219
|
-
optional :theme, enum: -> { Telnyx::AI::AssistantCreateParams::WidgetSettings::Theme }
|
|
220
|
-
|
|
221
|
-
# @!attribute view_history_url
|
|
222
|
-
# URL to view conversation history.
|
|
223
|
-
#
|
|
224
|
-
# @return [String, nil]
|
|
225
|
-
optional :view_history_url, String, nil?: true
|
|
226
|
-
|
|
227
|
-
# @!method initialize(agent_thinking_text: nil, audio_visualizer_config: nil, default_state: nil, give_feedback_url: nil, logo_icon_url: nil, position: nil, report_issue_url: nil, speak_to_interrupt_text: nil, start_call_text: nil, theme: nil, view_history_url: nil)
|
|
228
|
-
# Configuration settings for the assistant's web widget.
|
|
229
|
-
#
|
|
230
|
-
# @param agent_thinking_text [String] Text displayed while the agent is processing.
|
|
231
|
-
#
|
|
232
|
-
# @param audio_visualizer_config [Telnyx::Models::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig]
|
|
233
|
-
#
|
|
234
|
-
# @param default_state [Symbol, Telnyx::Models::AI::AssistantCreateParams::WidgetSettings::DefaultState] The default state of the widget.
|
|
235
|
-
#
|
|
236
|
-
# @param give_feedback_url [String, nil] URL for users to give feedback.
|
|
237
|
-
#
|
|
238
|
-
# @param logo_icon_url [String, nil] URL to a custom logo icon for the widget.
|
|
239
|
-
#
|
|
240
|
-
# @param position [Symbol, Telnyx::Models::AI::AssistantCreateParams::WidgetSettings::Position] The positioning style for the widget.
|
|
241
|
-
#
|
|
242
|
-
# @param report_issue_url [String, nil] URL for users to report issues.
|
|
243
|
-
#
|
|
244
|
-
# @param speak_to_interrupt_text [String] Text prompting users to speak to interrupt.
|
|
245
|
-
#
|
|
246
|
-
# @param start_call_text [String] Custom text displayed on the start call button.
|
|
247
|
-
#
|
|
248
|
-
# @param theme [Symbol, Telnyx::Models::AI::AssistantCreateParams::WidgetSettings::Theme] The visual theme for the widget.
|
|
249
|
-
#
|
|
250
|
-
# @param view_history_url [String, nil] URL to view conversation history.
|
|
251
|
-
|
|
252
|
-
# @see Telnyx::Models::AI::AssistantCreateParams::WidgetSettings#audio_visualizer_config
|
|
253
|
-
class AudioVisualizerConfig < Telnyx::Internal::Type::BaseModel
|
|
254
|
-
# @!attribute color
|
|
255
|
-
# The color theme for the audio visualizer.
|
|
256
|
-
#
|
|
257
|
-
# @return [Symbol, Telnyx::Models::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::Color, nil]
|
|
258
|
-
optional :color,
|
|
259
|
-
enum: -> { Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::Color }
|
|
260
|
-
|
|
261
|
-
# @!attribute preset
|
|
262
|
-
# The preset style for the audio visualizer.
|
|
263
|
-
#
|
|
264
|
-
# @return [String, nil]
|
|
265
|
-
optional :preset, String
|
|
266
|
-
|
|
267
|
-
# @!method initialize(color: nil, preset: nil)
|
|
268
|
-
# @param color [Symbol, Telnyx::Models::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::Color] The color theme for the audio visualizer.
|
|
269
|
-
#
|
|
270
|
-
# @param preset [String] The preset style for the audio visualizer.
|
|
271
|
-
|
|
272
|
-
# The color theme for the audio visualizer.
|
|
273
|
-
#
|
|
274
|
-
# @see Telnyx::Models::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig#color
|
|
275
|
-
module Color
|
|
276
|
-
extend Telnyx::Internal::Type::Enum
|
|
277
|
-
|
|
278
|
-
VERDANT = :verdant
|
|
279
|
-
TWILIGHT = :twilight
|
|
280
|
-
BLOOM = :bloom
|
|
281
|
-
MYSTIC = :mystic
|
|
282
|
-
FLARE = :flare
|
|
283
|
-
GLACIER = :glacier
|
|
284
|
-
|
|
285
|
-
# @!method self.values
|
|
286
|
-
# @return [Array<Symbol>]
|
|
287
|
-
end
|
|
288
|
-
end
|
|
289
|
-
|
|
290
|
-
# The default state of the widget.
|
|
291
|
-
#
|
|
292
|
-
# @see Telnyx::Models::AI::AssistantCreateParams::WidgetSettings#default_state
|
|
293
|
-
module DefaultState
|
|
294
|
-
extend Telnyx::Internal::Type::Enum
|
|
295
|
-
|
|
296
|
-
EXPANDED = :expanded
|
|
297
|
-
COLLAPSED = :collapsed
|
|
298
|
-
|
|
299
|
-
# @!method self.values
|
|
300
|
-
# @return [Array<Symbol>]
|
|
301
|
-
end
|
|
302
|
-
|
|
303
|
-
# The positioning style for the widget.
|
|
304
|
-
#
|
|
305
|
-
# @see Telnyx::Models::AI::AssistantCreateParams::WidgetSettings#position
|
|
306
|
-
module Position
|
|
307
|
-
extend Telnyx::Internal::Type::Enum
|
|
308
|
-
|
|
309
|
-
FIXED = :fixed
|
|
310
|
-
STATIC = :static
|
|
311
|
-
|
|
312
|
-
# @!method self.values
|
|
313
|
-
# @return [Array<Symbol>]
|
|
314
|
-
end
|
|
315
|
-
|
|
316
|
-
# The visual theme for the widget.
|
|
317
|
-
#
|
|
318
|
-
# @see Telnyx::Models::AI::AssistantCreateParams::WidgetSettings#theme
|
|
319
|
-
module Theme
|
|
320
|
-
extend Telnyx::Internal::Type::Enum
|
|
321
|
-
|
|
322
|
-
LIGHT = :light
|
|
323
|
-
DARK = :dark
|
|
324
|
-
|
|
325
|
-
# @!method self.values
|
|
326
|
-
# @return [Array<Symbol>]
|
|
327
|
-
end
|
|
328
|
-
end
|
|
329
159
|
end
|
|
330
160
|
end
|
|
331
161
|
end
|
|
@@ -121,8 +121,8 @@ module Telnyx
|
|
|
121
121
|
# @!attribute widget_settings
|
|
122
122
|
# Configuration settings for the assistant's web widget.
|
|
123
123
|
#
|
|
124
|
-
# @return [Telnyx::Models::AI::
|
|
125
|
-
optional :widget_settings, -> { Telnyx::AI::
|
|
124
|
+
# @return [Telnyx::Models::AI::WidgetSettings, nil]
|
|
125
|
+
optional :widget_settings, -> { Telnyx::AI::WidgetSettings }
|
|
126
126
|
|
|
127
127
|
# @!method initialize(description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, privacy_settings: nil, promote_to_main: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
|
|
128
128
|
# Some parameter documentations has been truncated, see
|
|
@@ -162,179 +162,9 @@ module Telnyx
|
|
|
162
162
|
#
|
|
163
163
|
# @param voice_settings [Telnyx::Models::AI::VoiceSettings]
|
|
164
164
|
#
|
|
165
|
-
# @param widget_settings [Telnyx::Models::AI::
|
|
165
|
+
# @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
|
|
166
166
|
#
|
|
167
167
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
168
|
-
|
|
169
|
-
class WidgetSettings < Telnyx::Internal::Type::BaseModel
|
|
170
|
-
# @!attribute agent_thinking_text
|
|
171
|
-
# Text displayed while the agent is processing.
|
|
172
|
-
#
|
|
173
|
-
# @return [String, nil]
|
|
174
|
-
optional :agent_thinking_text, String
|
|
175
|
-
|
|
176
|
-
# @!attribute audio_visualizer_config
|
|
177
|
-
#
|
|
178
|
-
# @return [Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::AudioVisualizerConfig, nil]
|
|
179
|
-
optional :audio_visualizer_config,
|
|
180
|
-
-> { Telnyx::AI::AssistantUpdateParams::WidgetSettings::AudioVisualizerConfig }
|
|
181
|
-
|
|
182
|
-
# @!attribute default_state
|
|
183
|
-
# The default state of the widget.
|
|
184
|
-
#
|
|
185
|
-
# @return [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::DefaultState, nil]
|
|
186
|
-
optional :default_state, enum: -> { Telnyx::AI::AssistantUpdateParams::WidgetSettings::DefaultState }
|
|
187
|
-
|
|
188
|
-
# @!attribute give_feedback_url
|
|
189
|
-
# URL for users to give feedback.
|
|
190
|
-
#
|
|
191
|
-
# @return [String, nil]
|
|
192
|
-
optional :give_feedback_url, String, nil?: true
|
|
193
|
-
|
|
194
|
-
# @!attribute logo_icon_url
|
|
195
|
-
# URL to a custom logo icon for the widget.
|
|
196
|
-
#
|
|
197
|
-
# @return [String, nil]
|
|
198
|
-
optional :logo_icon_url, String, nil?: true
|
|
199
|
-
|
|
200
|
-
# @!attribute position
|
|
201
|
-
# The positioning style for the widget.
|
|
202
|
-
#
|
|
203
|
-
# @return [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::Position, nil]
|
|
204
|
-
optional :position, enum: -> { Telnyx::AI::AssistantUpdateParams::WidgetSettings::Position }
|
|
205
|
-
|
|
206
|
-
# @!attribute report_issue_url
|
|
207
|
-
# URL for users to report issues.
|
|
208
|
-
#
|
|
209
|
-
# @return [String, nil]
|
|
210
|
-
optional :report_issue_url, String, nil?: true
|
|
211
|
-
|
|
212
|
-
# @!attribute speak_to_interrupt_text
|
|
213
|
-
# Text prompting users to speak to interrupt.
|
|
214
|
-
#
|
|
215
|
-
# @return [String, nil]
|
|
216
|
-
optional :speak_to_interrupt_text, String
|
|
217
|
-
|
|
218
|
-
# @!attribute start_call_text
|
|
219
|
-
# Custom text displayed on the start call button.
|
|
220
|
-
#
|
|
221
|
-
# @return [String, nil]
|
|
222
|
-
optional :start_call_text, String
|
|
223
|
-
|
|
224
|
-
# @!attribute theme
|
|
225
|
-
# The visual theme for the widget.
|
|
226
|
-
#
|
|
227
|
-
# @return [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::Theme, nil]
|
|
228
|
-
optional :theme, enum: -> { Telnyx::AI::AssistantUpdateParams::WidgetSettings::Theme }
|
|
229
|
-
|
|
230
|
-
# @!attribute view_history_url
|
|
231
|
-
# URL to view conversation history.
|
|
232
|
-
#
|
|
233
|
-
# @return [String, nil]
|
|
234
|
-
optional :view_history_url, String, nil?: true
|
|
235
|
-
|
|
236
|
-
# @!method initialize(agent_thinking_text: nil, audio_visualizer_config: nil, default_state: nil, give_feedback_url: nil, logo_icon_url: nil, position: nil, report_issue_url: nil, speak_to_interrupt_text: nil, start_call_text: nil, theme: nil, view_history_url: nil)
|
|
237
|
-
# Configuration settings for the assistant's web widget.
|
|
238
|
-
#
|
|
239
|
-
# @param agent_thinking_text [String] Text displayed while the agent is processing.
|
|
240
|
-
#
|
|
241
|
-
# @param audio_visualizer_config [Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::AudioVisualizerConfig]
|
|
242
|
-
#
|
|
243
|
-
# @param default_state [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::DefaultState] The default state of the widget.
|
|
244
|
-
#
|
|
245
|
-
# @param give_feedback_url [String, nil] URL for users to give feedback.
|
|
246
|
-
#
|
|
247
|
-
# @param logo_icon_url [String, nil] URL to a custom logo icon for the widget.
|
|
248
|
-
#
|
|
249
|
-
# @param position [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::Position] The positioning style for the widget.
|
|
250
|
-
#
|
|
251
|
-
# @param report_issue_url [String, nil] URL for users to report issues.
|
|
252
|
-
#
|
|
253
|
-
# @param speak_to_interrupt_text [String] Text prompting users to speak to interrupt.
|
|
254
|
-
#
|
|
255
|
-
# @param start_call_text [String] Custom text displayed on the start call button.
|
|
256
|
-
#
|
|
257
|
-
# @param theme [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::Theme] The visual theme for the widget.
|
|
258
|
-
#
|
|
259
|
-
# @param view_history_url [String, nil] URL to view conversation history.
|
|
260
|
-
|
|
261
|
-
# @see Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings#audio_visualizer_config
|
|
262
|
-
class AudioVisualizerConfig < Telnyx::Internal::Type::BaseModel
|
|
263
|
-
# @!attribute color
|
|
264
|
-
# The color theme for the audio visualizer.
|
|
265
|
-
#
|
|
266
|
-
# @return [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::AudioVisualizerConfig::Color, nil]
|
|
267
|
-
optional :color,
|
|
268
|
-
enum: -> { Telnyx::AI::AssistantUpdateParams::WidgetSettings::AudioVisualizerConfig::Color }
|
|
269
|
-
|
|
270
|
-
# @!attribute preset
|
|
271
|
-
# The preset style for the audio visualizer.
|
|
272
|
-
#
|
|
273
|
-
# @return [String, nil]
|
|
274
|
-
optional :preset, String
|
|
275
|
-
|
|
276
|
-
# @!method initialize(color: nil, preset: nil)
|
|
277
|
-
# @param color [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::AudioVisualizerConfig::Color] The color theme for the audio visualizer.
|
|
278
|
-
#
|
|
279
|
-
# @param preset [String] The preset style for the audio visualizer.
|
|
280
|
-
|
|
281
|
-
# The color theme for the audio visualizer.
|
|
282
|
-
#
|
|
283
|
-
# @see Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::AudioVisualizerConfig#color
|
|
284
|
-
module Color
|
|
285
|
-
extend Telnyx::Internal::Type::Enum
|
|
286
|
-
|
|
287
|
-
VERDANT = :verdant
|
|
288
|
-
TWILIGHT = :twilight
|
|
289
|
-
BLOOM = :bloom
|
|
290
|
-
MYSTIC = :mystic
|
|
291
|
-
FLARE = :flare
|
|
292
|
-
GLACIER = :glacier
|
|
293
|
-
|
|
294
|
-
# @!method self.values
|
|
295
|
-
# @return [Array<Symbol>]
|
|
296
|
-
end
|
|
297
|
-
end
|
|
298
|
-
|
|
299
|
-
# The default state of the widget.
|
|
300
|
-
#
|
|
301
|
-
# @see Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings#default_state
|
|
302
|
-
module DefaultState
|
|
303
|
-
extend Telnyx::Internal::Type::Enum
|
|
304
|
-
|
|
305
|
-
EXPANDED = :expanded
|
|
306
|
-
COLLAPSED = :collapsed
|
|
307
|
-
|
|
308
|
-
# @!method self.values
|
|
309
|
-
# @return [Array<Symbol>]
|
|
310
|
-
end
|
|
311
|
-
|
|
312
|
-
# The positioning style for the widget.
|
|
313
|
-
#
|
|
314
|
-
# @see Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings#position
|
|
315
|
-
module Position
|
|
316
|
-
extend Telnyx::Internal::Type::Enum
|
|
317
|
-
|
|
318
|
-
FIXED = :fixed
|
|
319
|
-
STATIC = :static
|
|
320
|
-
|
|
321
|
-
# @!method self.values
|
|
322
|
-
# @return [Array<Symbol>]
|
|
323
|
-
end
|
|
324
|
-
|
|
325
|
-
# The visual theme for the widget.
|
|
326
|
-
#
|
|
327
|
-
# @see Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings#theme
|
|
328
|
-
module Theme
|
|
329
|
-
extend Telnyx::Internal::Type::Enum
|
|
330
|
-
|
|
331
|
-
LIGHT = :light
|
|
332
|
-
DARK = :dark
|
|
333
|
-
|
|
334
|
-
# @!method self.values
|
|
335
|
-
# @return [Array<Symbol>]
|
|
336
|
-
end
|
|
337
|
-
end
|
|
338
168
|
end
|
|
339
169
|
end
|
|
340
170
|
end
|
|
@@ -111,8 +111,8 @@ module Telnyx
|
|
|
111
111
|
# @!attribute widget_settings
|
|
112
112
|
# Configuration settings for the assistant's web widget.
|
|
113
113
|
#
|
|
114
|
-
# @return [Telnyx::Models::AI::
|
|
115
|
-
optional :widget_settings, -> { Telnyx::AI::
|
|
114
|
+
# @return [Telnyx::Models::AI::WidgetSettings, nil]
|
|
115
|
+
optional :widget_settings, -> { Telnyx::AI::WidgetSettings }
|
|
116
116
|
|
|
117
117
|
# @!method initialize(description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, privacy_settings: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil)
|
|
118
118
|
# Some parameter documentations has been truncated, see
|
|
@@ -150,179 +150,7 @@ module Telnyx
|
|
|
150
150
|
#
|
|
151
151
|
# @param voice_settings [Telnyx::Models::AI::VoiceSettings]
|
|
152
152
|
#
|
|
153
|
-
# @param widget_settings [Telnyx::Models::AI::
|
|
154
|
-
|
|
155
|
-
# @see Telnyx::Models::AI::Assistants::UpdateAssistant#widget_settings
|
|
156
|
-
class WidgetSettings < Telnyx::Internal::Type::BaseModel
|
|
157
|
-
# @!attribute agent_thinking_text
|
|
158
|
-
# Text displayed while the agent is processing.
|
|
159
|
-
#
|
|
160
|
-
# @return [String, nil]
|
|
161
|
-
optional :agent_thinking_text, String
|
|
162
|
-
|
|
163
|
-
# @!attribute audio_visualizer_config
|
|
164
|
-
#
|
|
165
|
-
# @return [Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::AudioVisualizerConfig, nil]
|
|
166
|
-
optional :audio_visualizer_config,
|
|
167
|
-
-> { Telnyx::AI::Assistants::UpdateAssistant::WidgetSettings::AudioVisualizerConfig }
|
|
168
|
-
|
|
169
|
-
# @!attribute default_state
|
|
170
|
-
# The default state of the widget.
|
|
171
|
-
#
|
|
172
|
-
# @return [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::DefaultState, nil]
|
|
173
|
-
optional :default_state,
|
|
174
|
-
enum: -> { Telnyx::AI::Assistants::UpdateAssistant::WidgetSettings::DefaultState }
|
|
175
|
-
|
|
176
|
-
# @!attribute give_feedback_url
|
|
177
|
-
# URL for users to give feedback.
|
|
178
|
-
#
|
|
179
|
-
# @return [String, nil]
|
|
180
|
-
optional :give_feedback_url, String, nil?: true
|
|
181
|
-
|
|
182
|
-
# @!attribute logo_icon_url
|
|
183
|
-
# URL to a custom logo icon for the widget.
|
|
184
|
-
#
|
|
185
|
-
# @return [String, nil]
|
|
186
|
-
optional :logo_icon_url, String, nil?: true
|
|
187
|
-
|
|
188
|
-
# @!attribute position
|
|
189
|
-
# The positioning style for the widget.
|
|
190
|
-
#
|
|
191
|
-
# @return [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::Position, nil]
|
|
192
|
-
optional :position, enum: -> { Telnyx::AI::Assistants::UpdateAssistant::WidgetSettings::Position }
|
|
193
|
-
|
|
194
|
-
# @!attribute report_issue_url
|
|
195
|
-
# URL for users to report issues.
|
|
196
|
-
#
|
|
197
|
-
# @return [String, nil]
|
|
198
|
-
optional :report_issue_url, String, nil?: true
|
|
199
|
-
|
|
200
|
-
# @!attribute speak_to_interrupt_text
|
|
201
|
-
# Text prompting users to speak to interrupt.
|
|
202
|
-
#
|
|
203
|
-
# @return [String, nil]
|
|
204
|
-
optional :speak_to_interrupt_text, String
|
|
205
|
-
|
|
206
|
-
# @!attribute start_call_text
|
|
207
|
-
# Custom text displayed on the start call button.
|
|
208
|
-
#
|
|
209
|
-
# @return [String, nil]
|
|
210
|
-
optional :start_call_text, String
|
|
211
|
-
|
|
212
|
-
# @!attribute theme
|
|
213
|
-
# The visual theme for the widget.
|
|
214
|
-
#
|
|
215
|
-
# @return [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::Theme, nil]
|
|
216
|
-
optional :theme, enum: -> { Telnyx::AI::Assistants::UpdateAssistant::WidgetSettings::Theme }
|
|
217
|
-
|
|
218
|
-
# @!attribute view_history_url
|
|
219
|
-
# URL to view conversation history.
|
|
220
|
-
#
|
|
221
|
-
# @return [String, nil]
|
|
222
|
-
optional :view_history_url, String, nil?: true
|
|
223
|
-
|
|
224
|
-
# @!method initialize(agent_thinking_text: nil, audio_visualizer_config: nil, default_state: nil, give_feedback_url: nil, logo_icon_url: nil, position: nil, report_issue_url: nil, speak_to_interrupt_text: nil, start_call_text: nil, theme: nil, view_history_url: nil)
|
|
225
|
-
# Configuration settings for the assistant's web widget.
|
|
226
|
-
#
|
|
227
|
-
# @param agent_thinking_text [String] Text displayed while the agent is processing.
|
|
228
|
-
#
|
|
229
|
-
# @param audio_visualizer_config [Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::AudioVisualizerConfig]
|
|
230
|
-
#
|
|
231
|
-
# @param default_state [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::DefaultState] The default state of the widget.
|
|
232
|
-
#
|
|
233
|
-
# @param give_feedback_url [String, nil] URL for users to give feedback.
|
|
234
|
-
#
|
|
235
|
-
# @param logo_icon_url [String, nil] URL to a custom logo icon for the widget.
|
|
236
|
-
#
|
|
237
|
-
# @param position [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::Position] The positioning style for the widget.
|
|
238
|
-
#
|
|
239
|
-
# @param report_issue_url [String, nil] URL for users to report issues.
|
|
240
|
-
#
|
|
241
|
-
# @param speak_to_interrupt_text [String] Text prompting users to speak to interrupt.
|
|
242
|
-
#
|
|
243
|
-
# @param start_call_text [String] Custom text displayed on the start call button.
|
|
244
|
-
#
|
|
245
|
-
# @param theme [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::Theme] The visual theme for the widget.
|
|
246
|
-
#
|
|
247
|
-
# @param view_history_url [String, nil] URL to view conversation history.
|
|
248
|
-
|
|
249
|
-
# @see Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings#audio_visualizer_config
|
|
250
|
-
class AudioVisualizerConfig < Telnyx::Internal::Type::BaseModel
|
|
251
|
-
# @!attribute color
|
|
252
|
-
# The color theme for the audio visualizer.
|
|
253
|
-
#
|
|
254
|
-
# @return [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::AudioVisualizerConfig::Color, nil]
|
|
255
|
-
optional :color,
|
|
256
|
-
enum: -> { Telnyx::AI::Assistants::UpdateAssistant::WidgetSettings::AudioVisualizerConfig::Color }
|
|
257
|
-
|
|
258
|
-
# @!attribute preset
|
|
259
|
-
# The preset style for the audio visualizer.
|
|
260
|
-
#
|
|
261
|
-
# @return [String, nil]
|
|
262
|
-
optional :preset, String
|
|
263
|
-
|
|
264
|
-
# @!method initialize(color: nil, preset: nil)
|
|
265
|
-
# @param color [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::AudioVisualizerConfig::Color] The color theme for the audio visualizer.
|
|
266
|
-
#
|
|
267
|
-
# @param preset [String] The preset style for the audio visualizer.
|
|
268
|
-
|
|
269
|
-
# The color theme for the audio visualizer.
|
|
270
|
-
#
|
|
271
|
-
# @see Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::AudioVisualizerConfig#color
|
|
272
|
-
module Color
|
|
273
|
-
extend Telnyx::Internal::Type::Enum
|
|
274
|
-
|
|
275
|
-
VERDANT = :verdant
|
|
276
|
-
TWILIGHT = :twilight
|
|
277
|
-
BLOOM = :bloom
|
|
278
|
-
MYSTIC = :mystic
|
|
279
|
-
FLARE = :flare
|
|
280
|
-
GLACIER = :glacier
|
|
281
|
-
|
|
282
|
-
# @!method self.values
|
|
283
|
-
# @return [Array<Symbol>]
|
|
284
|
-
end
|
|
285
|
-
end
|
|
286
|
-
|
|
287
|
-
# The default state of the widget.
|
|
288
|
-
#
|
|
289
|
-
# @see Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings#default_state
|
|
290
|
-
module DefaultState
|
|
291
|
-
extend Telnyx::Internal::Type::Enum
|
|
292
|
-
|
|
293
|
-
EXPANDED = :expanded
|
|
294
|
-
COLLAPSED = :collapsed
|
|
295
|
-
|
|
296
|
-
# @!method self.values
|
|
297
|
-
# @return [Array<Symbol>]
|
|
298
|
-
end
|
|
299
|
-
|
|
300
|
-
# The positioning style for the widget.
|
|
301
|
-
#
|
|
302
|
-
# @see Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings#position
|
|
303
|
-
module Position
|
|
304
|
-
extend Telnyx::Internal::Type::Enum
|
|
305
|
-
|
|
306
|
-
FIXED = :fixed
|
|
307
|
-
STATIC = :static
|
|
308
|
-
|
|
309
|
-
# @!method self.values
|
|
310
|
-
# @return [Array<Symbol>]
|
|
311
|
-
end
|
|
312
|
-
|
|
313
|
-
# The visual theme for the widget.
|
|
314
|
-
#
|
|
315
|
-
# @see Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings#theme
|
|
316
|
-
module Theme
|
|
317
|
-
extend Telnyx::Internal::Type::Enum
|
|
318
|
-
|
|
319
|
-
LIGHT = :light
|
|
320
|
-
DARK = :dark
|
|
321
|
-
|
|
322
|
-
# @!method self.values
|
|
323
|
-
# @return [Array<Symbol>]
|
|
324
|
-
end
|
|
325
|
-
end
|
|
153
|
+
# @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
|
|
326
154
|
end
|
|
327
155
|
end
|
|
328
156
|
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
class AudioVisualizerConfig < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute color
|
|
8
|
+
# The color theme for the audio visualizer.
|
|
9
|
+
#
|
|
10
|
+
# @return [Symbol, Telnyx::Models::AI::AudioVisualizerConfig::Color, nil]
|
|
11
|
+
optional :color, enum: -> { Telnyx::AI::AudioVisualizerConfig::Color }
|
|
12
|
+
|
|
13
|
+
# @!attribute preset
|
|
14
|
+
# The preset style for the audio visualizer.
|
|
15
|
+
#
|
|
16
|
+
# @return [String, nil]
|
|
17
|
+
optional :preset, String
|
|
18
|
+
|
|
19
|
+
# @!method initialize(color: nil, preset: nil)
|
|
20
|
+
# @param color [Symbol, Telnyx::Models::AI::AudioVisualizerConfig::Color] The color theme for the audio visualizer.
|
|
21
|
+
#
|
|
22
|
+
# @param preset [String] The preset style for the audio visualizer.
|
|
23
|
+
|
|
24
|
+
# The color theme for the audio visualizer.
|
|
25
|
+
#
|
|
26
|
+
# @see Telnyx::Models::AI::AudioVisualizerConfig#color
|
|
27
|
+
module Color
|
|
28
|
+
extend Telnyx::Internal::Type::Enum
|
|
29
|
+
|
|
30
|
+
VERDANT = :verdant
|
|
31
|
+
TWILIGHT = :twilight
|
|
32
|
+
BLOOM = :bloom
|
|
33
|
+
MYSTIC = :mystic
|
|
34
|
+
FLARE = :flare
|
|
35
|
+
GLACIER = :glacier
|
|
36
|
+
|
|
37
|
+
# @!method self.values
|
|
38
|
+
# @return [Array<Symbol>]
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|