telnyx 5.56.0 → 5.58.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/models/calls/action_start_ai_assistant_params.rb +332 -1
- data/lib/telnyx/models/porting/loa_configuration_preview_params.rb +143 -0
- data/lib/telnyx/resources/calls/actions.rb +7 -1
- data/lib/telnyx/resources/porting/loa_configurations.rb +33 -1
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +1 -0
- data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +723 -0
- data/rbi/telnyx/models/porting/loa_configuration_preview_params.rbi +246 -0
- data/rbi/telnyx/resources/calls/actions.rbi +23 -0
- data/rbi/telnyx/resources/porting/loa_configurations.rbi +29 -0
- data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +293 -0
- data/sig/telnyx/models/porting/loa_configuration_preview_params.rbs +114 -0
- data/sig/telnyx/resources/calls/actions.rbs +3 -0
- data/sig/telnyx/resources/porting/loa_configurations.rbs +9 -0
- metadata +5 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: deb4068a838d94b98a182f7b76c9d0ee71d94fab0ec0956bafaab07d59af5dbc
|
|
4
|
+
data.tar.gz: 97349ade44f0e375639faadd120a0955e0c340fe20615a33b362bdceab146234
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 496d2ab49bc3c285f630627f0a9efd4f72970d1ef8f4cd3f6cdfe46b4249c8c342ea0162446f522484d832a42370e2ab7a882e9ba2254e98e8311ce03a9345fe
|
|
7
|
+
data.tar.gz: 6bd0084e27beba6a08b7d44d0cfa9ae790820ca87b1acf1d37f6576b7c3ea2c75c39b0cf5790b1a5ccd84a24241209c40b3b9f7cb07dd3a8dd357574a31bd835
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,22 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 5.58.0 (2026-03-18)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v5.57.0...v5.58.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.57.0...v5.58.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** manual updates ([75da4c3](https://github.com/team-telnyx/telnyx-ruby/commit/75da4c3c4172940b59f4bde26f7cf3f8e7530236))
|
|
10
|
+
|
|
11
|
+
## 5.57.0 (2026-03-18)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v5.56.0...v5.57.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.56.0...v5.57.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* add message_history, send_message_history_updates, participants to AIAssistantStartRequest ([db0e6fc](https://github.com/team-telnyx/telnyx-ruby/commit/db0e6fc8c78a08159aa2e9e73472c3fa2c092405))
|
|
18
|
+
* port-4690: fix LOA configuration preview path (singular → plural) ([faa937b](https://github.com/team-telnyx/telnyx-ruby/commit/faa937bce19e78bcc88bb13155e0ef57c897b97d))
|
|
19
|
+
|
|
3
20
|
## 5.56.0 (2026-03-17)
|
|
4
21
|
|
|
5
22
|
Full Changelog: [v5.55.0...v5.56.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.55.0...v5.56.0)
|
data/README.md
CHANGED
|
@@ -47,6 +47,28 @@ module Telnyx
|
|
|
47
47
|
# @return [Telnyx::Models::Calls::InterruptionSettings, nil]
|
|
48
48
|
optional :interruption_settings, -> { Telnyx::Calls::InterruptionSettings }
|
|
49
49
|
|
|
50
|
+
# @!attribute message_history
|
|
51
|
+
# A list of messages to seed the conversation history before the assistant starts.
|
|
52
|
+
# Follows the same message format as the `ai_assistant_add_messages` command.
|
|
53
|
+
#
|
|
54
|
+
# @return [Array<Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::User, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Tool, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::System, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Developer>, nil]
|
|
55
|
+
optional :message_history,
|
|
56
|
+
-> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory] }
|
|
57
|
+
|
|
58
|
+
# @!attribute participants
|
|
59
|
+
# A list of participants to add to the conversation when it starts.
|
|
60
|
+
#
|
|
61
|
+
# @return [Array<Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant>, nil]
|
|
62
|
+
optional :participants,
|
|
63
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Calls::ActionStartAIAssistantParams::Participant] }
|
|
64
|
+
|
|
65
|
+
# @!attribute send_message_history_updates
|
|
66
|
+
# When `true`, a webhook is sent each time the conversation message history is
|
|
67
|
+
# updated.
|
|
68
|
+
#
|
|
69
|
+
# @return [Boolean, nil]
|
|
70
|
+
optional :send_message_history_updates, Telnyx::Internal::Type::Boolean
|
|
71
|
+
|
|
50
72
|
# @!attribute transcription
|
|
51
73
|
# The settings associated with speech to text for the voice assistant. This is
|
|
52
74
|
# only relevant if the assistant uses a text-to-text language model. Any assistant
|
|
@@ -91,7 +113,7 @@ module Telnyx
|
|
|
91
113
|
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, nil]
|
|
92
114
|
optional :voice_settings, union: -> { Telnyx::Calls::ActionStartAIAssistantParams::VoiceSettings }
|
|
93
115
|
|
|
94
|
-
# @!method initialize(call_control_id:, assistant: nil, client_state: nil, command_id: nil, greeting: nil, interruption_settings: nil, transcription: nil, voice: nil, voice_settings: nil, request_options: {})
|
|
116
|
+
# @!method initialize(call_control_id:, assistant: nil, client_state: nil, command_id: nil, greeting: nil, interruption_settings: nil, message_history: nil, participants: nil, send_message_history_updates: nil, transcription: nil, voice: nil, voice_settings: nil, request_options: {})
|
|
95
117
|
# Some parameter documentations has been truncated, see
|
|
96
118
|
# {Telnyx::Models::Calls::ActionStartAIAssistantParams} for more details.
|
|
97
119
|
#
|
|
@@ -107,6 +129,12 @@ module Telnyx
|
|
|
107
129
|
#
|
|
108
130
|
# @param interruption_settings [Telnyx::Models::Calls::InterruptionSettings] Settings for handling user interruptions during assistant speech
|
|
109
131
|
#
|
|
132
|
+
# @param message_history [Array<Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::User, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Tool, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::System, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Developer>] A list of messages to seed the conversation history before the assistant starts.
|
|
133
|
+
#
|
|
134
|
+
# @param participants [Array<Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant>] A list of participants to add to the conversation when it starts.
|
|
135
|
+
#
|
|
136
|
+
# @param send_message_history_updates [Boolean] When `true`, a webhook is sent each time the conversation message history is upd
|
|
137
|
+
#
|
|
110
138
|
# @param transcription [Telnyx::Models::Calls::TranscriptionConfig] The settings associated with speech to text for the voice assistant. This is onl
|
|
111
139
|
#
|
|
112
140
|
# @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
|
|
@@ -150,6 +178,309 @@ module Telnyx
|
|
|
150
178
|
# @param openai_api_key_ref [String] Reference to the OpenAI API key. Required only when using OpenAI models
|
|
151
179
|
end
|
|
152
180
|
|
|
181
|
+
# Messages sent by an end user
|
|
182
|
+
module MessageHistory
|
|
183
|
+
extend Telnyx::Internal::Type::Union
|
|
184
|
+
|
|
185
|
+
discriminator :role
|
|
186
|
+
|
|
187
|
+
# Messages sent by an end user
|
|
188
|
+
variant :user, -> { Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory::User }
|
|
189
|
+
|
|
190
|
+
# Messages sent by the model in response to user messages.
|
|
191
|
+
variant :assistant, -> { Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant }
|
|
192
|
+
|
|
193
|
+
variant :tool, -> { Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory::Tool }
|
|
194
|
+
|
|
195
|
+
# Developer-provided instructions that the model should follow, regardless of messages sent by the user.
|
|
196
|
+
variant :system, -> { Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory::System }
|
|
197
|
+
|
|
198
|
+
# Developer-provided instructions that the model should follow, regardless of messages sent by the user.
|
|
199
|
+
variant :developer, -> { Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory::Developer }
|
|
200
|
+
|
|
201
|
+
class User < Telnyx::Internal::Type::BaseModel
|
|
202
|
+
# @!attribute content
|
|
203
|
+
# The contents of the user message.
|
|
204
|
+
#
|
|
205
|
+
# @return [String]
|
|
206
|
+
required :content, String
|
|
207
|
+
|
|
208
|
+
# @!attribute role
|
|
209
|
+
# The role of the messages author, in this case `user`.
|
|
210
|
+
#
|
|
211
|
+
# @return [Symbol, :user]
|
|
212
|
+
required :role, const: :user
|
|
213
|
+
|
|
214
|
+
# @!attribute metadata
|
|
215
|
+
# Metadata to add to the message
|
|
216
|
+
#
|
|
217
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
218
|
+
optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
219
|
+
|
|
220
|
+
# @!method initialize(content:, metadata: nil, role: :user)
|
|
221
|
+
# Messages sent by an end user
|
|
222
|
+
#
|
|
223
|
+
# @param content [String] The contents of the user message.
|
|
224
|
+
#
|
|
225
|
+
# @param metadata [Hash{Symbol=>Object}] Metadata to add to the message
|
|
226
|
+
#
|
|
227
|
+
# @param role [Symbol, :user] The role of the messages author, in this case `user`.
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
class Assistant < Telnyx::Internal::Type::BaseModel
|
|
231
|
+
# @!attribute role
|
|
232
|
+
# The role of the messages author, in this case `assistant`.
|
|
233
|
+
#
|
|
234
|
+
# @return [Symbol, :assistant]
|
|
235
|
+
required :role, const: :assistant
|
|
236
|
+
|
|
237
|
+
# @!attribute content
|
|
238
|
+
# The contents of the assistant message. Required unless `tool_calls`
|
|
239
|
+
#
|
|
240
|
+
# @return [String, nil]
|
|
241
|
+
optional :content, String
|
|
242
|
+
|
|
243
|
+
# @!attribute metadata
|
|
244
|
+
# Metadata to add to the message
|
|
245
|
+
#
|
|
246
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
247
|
+
optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
248
|
+
|
|
249
|
+
# @!attribute tool_calls
|
|
250
|
+
# The tool calls generated by the model, such as function calls.
|
|
251
|
+
#
|
|
252
|
+
# @return [Array<Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall>, nil]
|
|
253
|
+
optional :tool_calls,
|
|
254
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall] }
|
|
255
|
+
|
|
256
|
+
# @!method initialize(content: nil, metadata: nil, tool_calls: nil, role: :assistant)
|
|
257
|
+
# Messages sent by the model in response to user messages.
|
|
258
|
+
#
|
|
259
|
+
# @param content [String] The contents of the assistant message. Required unless `tool_calls`
|
|
260
|
+
#
|
|
261
|
+
# @param metadata [Hash{Symbol=>Object}] Metadata to add to the message
|
|
262
|
+
#
|
|
263
|
+
# @param tool_calls [Array<Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall>] The tool calls generated by the model, such as function calls.
|
|
264
|
+
#
|
|
265
|
+
# @param role [Symbol, :assistant] The role of the messages author, in this case `assistant`.
|
|
266
|
+
|
|
267
|
+
class ToolCall < Telnyx::Internal::Type::BaseModel
|
|
268
|
+
# @!attribute id
|
|
269
|
+
# The ID of the tool call.
|
|
270
|
+
#
|
|
271
|
+
# @return [String]
|
|
272
|
+
required :id, String
|
|
273
|
+
|
|
274
|
+
# @!attribute function
|
|
275
|
+
# The function that the model called.
|
|
276
|
+
#
|
|
277
|
+
# @return [Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Function]
|
|
278
|
+
required :function,
|
|
279
|
+
-> { Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Function }
|
|
280
|
+
|
|
281
|
+
# @!attribute type
|
|
282
|
+
# The type of the tool. Currently, only `function` is supported.
|
|
283
|
+
#
|
|
284
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Type]
|
|
285
|
+
required :type,
|
|
286
|
+
enum: -> { Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Type }
|
|
287
|
+
|
|
288
|
+
# @!method initialize(id:, function:, type:)
|
|
289
|
+
# A call to a function tool created by the model.
|
|
290
|
+
#
|
|
291
|
+
# @param id [String] The ID of the tool call.
|
|
292
|
+
#
|
|
293
|
+
# @param function [Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Function] The function that the model called.
|
|
294
|
+
#
|
|
295
|
+
# @param type [Symbol, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Type] The type of the tool. Currently, only `function` is supported.
|
|
296
|
+
|
|
297
|
+
# @see Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall#function
|
|
298
|
+
class Function < Telnyx::Internal::Type::BaseModel
|
|
299
|
+
# @!attribute name
|
|
300
|
+
# The name of the function to call.
|
|
301
|
+
#
|
|
302
|
+
# @return [String]
|
|
303
|
+
required :name, String
|
|
304
|
+
|
|
305
|
+
# @!method initialize(name:)
|
|
306
|
+
# The function that the model called.
|
|
307
|
+
#
|
|
308
|
+
# @param name [String] The name of the function to call.
|
|
309
|
+
end
|
|
310
|
+
|
|
311
|
+
# The type of the tool. Currently, only `function` is supported.
|
|
312
|
+
#
|
|
313
|
+
# @see Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall#type
|
|
314
|
+
module Type
|
|
315
|
+
extend Telnyx::Internal::Type::Enum
|
|
316
|
+
|
|
317
|
+
FUNCTION = :function
|
|
318
|
+
|
|
319
|
+
# @!method self.values
|
|
320
|
+
# @return [Array<Symbol>]
|
|
321
|
+
end
|
|
322
|
+
end
|
|
323
|
+
end
|
|
324
|
+
|
|
325
|
+
class Tool < Telnyx::Internal::Type::BaseModel
|
|
326
|
+
# @!attribute content
|
|
327
|
+
# The contents of the tool message.
|
|
328
|
+
#
|
|
329
|
+
# @return [String]
|
|
330
|
+
required :content, String
|
|
331
|
+
|
|
332
|
+
# @!attribute role
|
|
333
|
+
# The role of the messages author, in this case `tool`.
|
|
334
|
+
#
|
|
335
|
+
# @return [Symbol, :tool]
|
|
336
|
+
required :role, const: :tool
|
|
337
|
+
|
|
338
|
+
# @!attribute tool_call_id
|
|
339
|
+
# Tool call that this message is responding to.
|
|
340
|
+
#
|
|
341
|
+
# @return [String]
|
|
342
|
+
required :tool_call_id, String
|
|
343
|
+
|
|
344
|
+
# @!attribute metadata
|
|
345
|
+
# Metadata to add to the message
|
|
346
|
+
#
|
|
347
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
348
|
+
optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
349
|
+
|
|
350
|
+
# @!method initialize(content:, tool_call_id:, metadata: nil, role: :tool)
|
|
351
|
+
# @param content [String] The contents of the tool message.
|
|
352
|
+
#
|
|
353
|
+
# @param tool_call_id [String] Tool call that this message is responding to.
|
|
354
|
+
#
|
|
355
|
+
# @param metadata [Hash{Symbol=>Object}] Metadata to add to the message
|
|
356
|
+
#
|
|
357
|
+
# @param role [Symbol, :tool] The role of the messages author, in this case `tool`.
|
|
358
|
+
end
|
|
359
|
+
|
|
360
|
+
class System < Telnyx::Internal::Type::BaseModel
|
|
361
|
+
# @!attribute content
|
|
362
|
+
# The contents of the system message.
|
|
363
|
+
#
|
|
364
|
+
# @return [String]
|
|
365
|
+
required :content, String
|
|
366
|
+
|
|
367
|
+
# @!attribute role
|
|
368
|
+
# The role of the messages author, in this case `system`.
|
|
369
|
+
#
|
|
370
|
+
# @return [Symbol, :system]
|
|
371
|
+
required :role, const: :system
|
|
372
|
+
|
|
373
|
+
# @!attribute metadata
|
|
374
|
+
# Metadata to add to the message
|
|
375
|
+
#
|
|
376
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
377
|
+
optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
378
|
+
|
|
379
|
+
# @!method initialize(content:, metadata: nil, role: :system)
|
|
380
|
+
# Developer-provided instructions that the model should follow, regardless of
|
|
381
|
+
# messages sent by the user.
|
|
382
|
+
#
|
|
383
|
+
# @param content [String] The contents of the system message.
|
|
384
|
+
#
|
|
385
|
+
# @param metadata [Hash{Symbol=>Object}] Metadata to add to the message
|
|
386
|
+
#
|
|
387
|
+
# @param role [Symbol, :system] The role of the messages author, in this case `system`.
|
|
388
|
+
end
|
|
389
|
+
|
|
390
|
+
class Developer < Telnyx::Internal::Type::BaseModel
|
|
391
|
+
# @!attribute content
|
|
392
|
+
# The contents of the developer message.
|
|
393
|
+
#
|
|
394
|
+
# @return [String]
|
|
395
|
+
required :content, String
|
|
396
|
+
|
|
397
|
+
# @!attribute role
|
|
398
|
+
# The role of the messages author, in this case developer.
|
|
399
|
+
#
|
|
400
|
+
# @return [Symbol, :developer]
|
|
401
|
+
required :role, const: :developer
|
|
402
|
+
|
|
403
|
+
# @!attribute metadata
|
|
404
|
+
# Metadata to add to the message
|
|
405
|
+
#
|
|
406
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
407
|
+
optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
408
|
+
|
|
409
|
+
# @!method initialize(content:, metadata: nil, role: :developer)
|
|
410
|
+
# Developer-provided instructions that the model should follow, regardless of
|
|
411
|
+
# messages sent by the user.
|
|
412
|
+
#
|
|
413
|
+
# @param content [String] The contents of the developer message.
|
|
414
|
+
#
|
|
415
|
+
# @param metadata [Hash{Symbol=>Object}] Metadata to add to the message
|
|
416
|
+
#
|
|
417
|
+
# @param role [Symbol, :developer] The role of the messages author, in this case developer.
|
|
418
|
+
end
|
|
419
|
+
|
|
420
|
+
# @!method self.variants
|
|
421
|
+
# @return [Array(Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::User, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Tool, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::System, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Developer)]
|
|
422
|
+
end
|
|
423
|
+
|
|
424
|
+
class Participant < Telnyx::Internal::Type::BaseModel
|
|
425
|
+
# @!attribute id
|
|
426
|
+
# The call_control_id of the participant to add to the conversation.
|
|
427
|
+
#
|
|
428
|
+
# @return [String]
|
|
429
|
+
required :id, String
|
|
430
|
+
|
|
431
|
+
# @!attribute role
|
|
432
|
+
# The role of the participant in the conversation.
|
|
433
|
+
#
|
|
434
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant::Role]
|
|
435
|
+
required :role, enum: -> { Telnyx::Calls::ActionStartAIAssistantParams::Participant::Role }
|
|
436
|
+
|
|
437
|
+
# @!attribute name
|
|
438
|
+
# Display name for the participant.
|
|
439
|
+
#
|
|
440
|
+
# @return [String, nil]
|
|
441
|
+
optional :name, String
|
|
442
|
+
|
|
443
|
+
# @!attribute on_hangup
|
|
444
|
+
# Determines what happens to the conversation when this participant hangs up.
|
|
445
|
+
#
|
|
446
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant::OnHangup, nil]
|
|
447
|
+
optional :on_hangup, enum: -> { Telnyx::Calls::ActionStartAIAssistantParams::Participant::OnHangup }
|
|
448
|
+
|
|
449
|
+
# @!method initialize(id:, role:, name: nil, on_hangup: nil)
|
|
450
|
+
# @param id [String] The call_control_id of the participant to add to the conversation.
|
|
451
|
+
#
|
|
452
|
+
# @param role [Symbol, Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant::Role] The role of the participant in the conversation.
|
|
453
|
+
#
|
|
454
|
+
# @param name [String] Display name for the participant.
|
|
455
|
+
#
|
|
456
|
+
# @param on_hangup [Symbol, Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant::OnHangup] Determines what happens to the conversation when this participant hangs up.
|
|
457
|
+
|
|
458
|
+
# The role of the participant in the conversation.
|
|
459
|
+
#
|
|
460
|
+
# @see Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant#role
|
|
461
|
+
module Role
|
|
462
|
+
extend Telnyx::Internal::Type::Enum
|
|
463
|
+
|
|
464
|
+
USER = :user
|
|
465
|
+
|
|
466
|
+
# @!method self.values
|
|
467
|
+
# @return [Array<Symbol>]
|
|
468
|
+
end
|
|
469
|
+
|
|
470
|
+
# Determines what happens to the conversation when this participant hangs up.
|
|
471
|
+
#
|
|
472
|
+
# @see Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant#on_hangup
|
|
473
|
+
module OnHangup
|
|
474
|
+
extend Telnyx::Internal::Type::Enum
|
|
475
|
+
|
|
476
|
+
CONTINUE_CONVERSATION = :continue_conversation
|
|
477
|
+
END_CONVERSATION = :end_conversation
|
|
478
|
+
|
|
479
|
+
# @!method self.values
|
|
480
|
+
# @return [Array<Symbol>]
|
|
481
|
+
end
|
|
482
|
+
end
|
|
483
|
+
|
|
153
484
|
# The settings associated with the voice selected
|
|
154
485
|
module VoiceSettings
|
|
155
486
|
extend Telnyx::Internal::Type::Union
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Porting
|
|
6
|
+
# @see Telnyx::Resources::Porting::LoaConfigurations#preview
|
|
7
|
+
class LoaConfigurationPreviewParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute address
|
|
12
|
+
# The address of the company.
|
|
13
|
+
#
|
|
14
|
+
# @return [Telnyx::Models::Porting::LoaConfigurationPreviewParams::Address]
|
|
15
|
+
required :address, -> { Telnyx::Porting::LoaConfigurationPreviewParams::Address }
|
|
16
|
+
|
|
17
|
+
# @!attribute company_name
|
|
18
|
+
# The name of the company
|
|
19
|
+
#
|
|
20
|
+
# @return [String]
|
|
21
|
+
required :company_name, String
|
|
22
|
+
|
|
23
|
+
# @!attribute contact
|
|
24
|
+
# The contact information of the company.
|
|
25
|
+
#
|
|
26
|
+
# @return [Telnyx::Models::Porting::LoaConfigurationPreviewParams::Contact]
|
|
27
|
+
required :contact, -> { Telnyx::Porting::LoaConfigurationPreviewParams::Contact }
|
|
28
|
+
|
|
29
|
+
# @!attribute logo
|
|
30
|
+
# The logo of the LOA configuration
|
|
31
|
+
#
|
|
32
|
+
# @return [Telnyx::Models::Porting::LoaConfigurationPreviewParams::Logo]
|
|
33
|
+
required :logo, -> { Telnyx::Porting::LoaConfigurationPreviewParams::Logo }
|
|
34
|
+
|
|
35
|
+
# @!attribute name
|
|
36
|
+
# The name of the LOA configuration
|
|
37
|
+
#
|
|
38
|
+
# @return [String]
|
|
39
|
+
required :name, String
|
|
40
|
+
|
|
41
|
+
# @!method initialize(address:, company_name:, contact:, logo:, name:, request_options: {})
|
|
42
|
+
# @param address [Telnyx::Models::Porting::LoaConfigurationPreviewParams::Address] The address of the company.
|
|
43
|
+
#
|
|
44
|
+
# @param company_name [String] The name of the company
|
|
45
|
+
#
|
|
46
|
+
# @param contact [Telnyx::Models::Porting::LoaConfigurationPreviewParams::Contact] The contact information of the company.
|
|
47
|
+
#
|
|
48
|
+
# @param logo [Telnyx::Models::Porting::LoaConfigurationPreviewParams::Logo] The logo of the LOA configuration
|
|
49
|
+
#
|
|
50
|
+
# @param name [String] The name of the LOA configuration
|
|
51
|
+
#
|
|
52
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
53
|
+
|
|
54
|
+
class Address < Telnyx::Internal::Type::BaseModel
|
|
55
|
+
# @!attribute city
|
|
56
|
+
# The locality of the company
|
|
57
|
+
#
|
|
58
|
+
# @return [String]
|
|
59
|
+
required :city, String
|
|
60
|
+
|
|
61
|
+
# @!attribute country_code
|
|
62
|
+
# The country code of the company
|
|
63
|
+
#
|
|
64
|
+
# @return [String]
|
|
65
|
+
required :country_code, String
|
|
66
|
+
|
|
67
|
+
# @!attribute state
|
|
68
|
+
# The administrative area of the company
|
|
69
|
+
#
|
|
70
|
+
# @return [String]
|
|
71
|
+
required :state, String
|
|
72
|
+
|
|
73
|
+
# @!attribute street_address
|
|
74
|
+
# The street address of the company
|
|
75
|
+
#
|
|
76
|
+
# @return [String]
|
|
77
|
+
required :street_address, String
|
|
78
|
+
|
|
79
|
+
# @!attribute zip_code
|
|
80
|
+
# The postal code of the company
|
|
81
|
+
#
|
|
82
|
+
# @return [String]
|
|
83
|
+
required :zip_code, String
|
|
84
|
+
|
|
85
|
+
# @!attribute extended_address
|
|
86
|
+
# The extended address of the company
|
|
87
|
+
#
|
|
88
|
+
# @return [String, nil]
|
|
89
|
+
optional :extended_address, String
|
|
90
|
+
|
|
91
|
+
# @!method initialize(city:, country_code:, state:, street_address:, zip_code:, extended_address: nil)
|
|
92
|
+
# The address of the company.
|
|
93
|
+
#
|
|
94
|
+
# @param city [String] The locality of the company
|
|
95
|
+
#
|
|
96
|
+
# @param country_code [String] The country code of the company
|
|
97
|
+
#
|
|
98
|
+
# @param state [String] The administrative area of the company
|
|
99
|
+
#
|
|
100
|
+
# @param street_address [String] The street address of the company
|
|
101
|
+
#
|
|
102
|
+
# @param zip_code [String] The postal code of the company
|
|
103
|
+
#
|
|
104
|
+
# @param extended_address [String] The extended address of the company
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
class Contact < Telnyx::Internal::Type::BaseModel
|
|
108
|
+
# @!attribute email
|
|
109
|
+
# The email address of the contact
|
|
110
|
+
#
|
|
111
|
+
# @return [String]
|
|
112
|
+
required :email, String
|
|
113
|
+
|
|
114
|
+
# @!attribute phone_number
|
|
115
|
+
# The phone number of the contact
|
|
116
|
+
#
|
|
117
|
+
# @return [String]
|
|
118
|
+
required :phone_number, String
|
|
119
|
+
|
|
120
|
+
# @!method initialize(email:, phone_number:)
|
|
121
|
+
# The contact information of the company.
|
|
122
|
+
#
|
|
123
|
+
# @param email [String] The email address of the contact
|
|
124
|
+
#
|
|
125
|
+
# @param phone_number [String] The phone number of the contact
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
class Logo < Telnyx::Internal::Type::BaseModel
|
|
129
|
+
# @!attribute document_id
|
|
130
|
+
# The document identification
|
|
131
|
+
#
|
|
132
|
+
# @return [String]
|
|
133
|
+
required :document_id, String
|
|
134
|
+
|
|
135
|
+
# @!method initialize(document_id:)
|
|
136
|
+
# The logo of the LOA configuration
|
|
137
|
+
#
|
|
138
|
+
# @param document_id [String] The document identification
|
|
139
|
+
end
|
|
140
|
+
end
|
|
141
|
+
end
|
|
142
|
+
end
|
|
143
|
+
end
|
|
@@ -880,7 +880,7 @@ module Telnyx
|
|
|
880
880
|
# - `call.conversation.ended`
|
|
881
881
|
# - `call.conversation_insights.generated`
|
|
882
882
|
#
|
|
883
|
-
# @overload start_ai_assistant(call_control_id, assistant: nil, client_state: nil, command_id: nil, greeting: nil, interruption_settings: nil, transcription: nil, voice: nil, voice_settings: nil, request_options: {})
|
|
883
|
+
# @overload start_ai_assistant(call_control_id, assistant: nil, client_state: nil, command_id: nil, greeting: nil, interruption_settings: nil, message_history: nil, participants: nil, send_message_history_updates: nil, transcription: nil, voice: nil, voice_settings: nil, request_options: {})
|
|
884
884
|
#
|
|
885
885
|
# @param call_control_id [String] Unique identifier and token for controlling the call
|
|
886
886
|
#
|
|
@@ -894,6 +894,12 @@ module Telnyx
|
|
|
894
894
|
#
|
|
895
895
|
# @param interruption_settings [Telnyx::Models::Calls::InterruptionSettings] Settings for handling user interruptions during assistant speech
|
|
896
896
|
#
|
|
897
|
+
# @param message_history [Array<Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::User, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Tool, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::System, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Developer>] A list of messages to seed the conversation history before the assistant starts.
|
|
898
|
+
#
|
|
899
|
+
# @param participants [Array<Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant>] A list of participants to add to the conversation when it starts.
|
|
900
|
+
#
|
|
901
|
+
# @param send_message_history_updates [Boolean] When `true`, a webhook is sent each time the conversation message history is upd
|
|
902
|
+
#
|
|
897
903
|
# @param transcription [Telnyx::Models::Calls::TranscriptionConfig] The settings associated with speech to text for the voice assistant. This is onl
|
|
898
904
|
#
|
|
899
905
|
# @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
|
|
@@ -131,6 +131,38 @@ module Telnyx
|
|
|
131
131
|
)
|
|
132
132
|
end
|
|
133
133
|
|
|
134
|
+
# Preview the LOA template that would be generated without need to create LOA
|
|
135
|
+
# configuration.
|
|
136
|
+
#
|
|
137
|
+
# @overload preview(address:, company_name:, contact:, logo:, name:, request_options: {})
|
|
138
|
+
#
|
|
139
|
+
# @param address [Telnyx::Models::Porting::LoaConfigurationPreviewParams::Address] The address of the company.
|
|
140
|
+
#
|
|
141
|
+
# @param company_name [String] The name of the company
|
|
142
|
+
#
|
|
143
|
+
# @param contact [Telnyx::Models::Porting::LoaConfigurationPreviewParams::Contact] The contact information of the company.
|
|
144
|
+
#
|
|
145
|
+
# @param logo [Telnyx::Models::Porting::LoaConfigurationPreviewParams::Logo] The logo of the LOA configuration
|
|
146
|
+
#
|
|
147
|
+
# @param name [String] The name of the LOA configuration
|
|
148
|
+
#
|
|
149
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
150
|
+
#
|
|
151
|
+
# @return [StringIO]
|
|
152
|
+
#
|
|
153
|
+
# @see Telnyx::Models::Porting::LoaConfigurationPreviewParams
|
|
154
|
+
def preview(params)
|
|
155
|
+
parsed, options = Telnyx::Porting::LoaConfigurationPreviewParams.dump_request(params)
|
|
156
|
+
@client.request(
|
|
157
|
+
method: :post,
|
|
158
|
+
path: "porting/loa_configurations/preview",
|
|
159
|
+
headers: {"accept" => "application/pdf"},
|
|
160
|
+
body: parsed,
|
|
161
|
+
model: StringIO,
|
|
162
|
+
options: options
|
|
163
|
+
)
|
|
164
|
+
end
|
|
165
|
+
|
|
134
166
|
# Preview the LOA template that would be generated without need to create LOA
|
|
135
167
|
# configuration.
|
|
136
168
|
#
|
|
@@ -155,7 +187,7 @@ module Telnyx
|
|
|
155
187
|
parsed, options = Telnyx::Porting::LoaConfigurationPreview0Params.dump_request(params)
|
|
156
188
|
@client.request(
|
|
157
189
|
method: :post,
|
|
158
|
-
path: "porting/
|
|
190
|
+
path: "porting/loa_configurations/preview",
|
|
159
191
|
headers: {"accept" => "application/pdf"},
|
|
160
192
|
body: parsed,
|
|
161
193
|
model: StringIO,
|
data/lib/telnyx/version.rb
CHANGED
data/lib/telnyx.rb
CHANGED
|
@@ -1558,6 +1558,7 @@ require_relative "telnyx/models/porting/loa_configuration_delete_params"
|
|
|
1558
1558
|
require_relative "telnyx/models/porting/loa_configuration_list_params"
|
|
1559
1559
|
require_relative "telnyx/models/porting/loa_configuration_preview_0_params"
|
|
1560
1560
|
require_relative "telnyx/models/porting/loa_configuration_preview_1_params"
|
|
1561
|
+
require_relative "telnyx/models/porting/loa_configuration_preview_params"
|
|
1561
1562
|
require_relative "telnyx/models/porting/loa_configuration_retrieve_params"
|
|
1562
1563
|
require_relative "telnyx/models/porting/loa_configuration_retrieve_response"
|
|
1563
1564
|
require_relative "telnyx/models/porting/loa_configuration_update_params"
|