revox 0.1.0 → 0.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 +71 -0
- data/README.md +39 -14
- data/lib/revox/client.rb +15 -1
- data/lib/revox/internal/transport/base_client.rb +5 -0
- data/lib/revox/internal/util.rb +22 -7
- data/lib/revox/models/assistant_create_params.rb +1038 -13
- data/lib/revox/models/assistant_create_response.rb +1071 -11
- data/lib/revox/models/assistant_list_response.rb +1070 -11
- data/lib/revox/models/assistant_retrieve_response.rb +1066 -11
- data/lib/revox/models/assistant_update_params.rb +1038 -13
- data/lib/revox/models/assistant_update_response.rb +1097 -12
- data/lib/revox/models/call_create_params.rb +1065 -13
- data/lib/revox/models/call_create_response.rb +1813 -101
- data/lib/revox/models/call_retrieve_response.rb +1815 -101
- data/lib/revox/models/campaign_create_params.rb +67 -2
- data/lib/revox/models/campaign_create_response.rb +1314 -59
- data/lib/revox/models/campaign_get_rows_params.rb +1 -46
- data/lib/revox/models/campaign_get_rows_response.rb +1837 -129
- data/lib/revox/models/campaign_list_response.rb +1312 -59
- data/lib/revox/models/campaign_retrieve_response.rb +1312 -56
- data/lib/revox/models/users/me_retrieve_response.rb +13 -1
- data/lib/revox/models/users/me_update_response.rb +13 -1
- data/lib/revox/models/voice_list_response.rb +55 -1
- data/lib/revox/models/voice_preview_params.rb +49 -1
- data/lib/revox/models.rb +0 -2
- data/lib/revox/resources/assistants.rb +116 -8
- data/lib/revox/resources/call.rb +0 -29
- data/lib/revox/resources/campaigns.rb +12 -17
- data/lib/revox/resources/voices.rb +16 -10
- data/lib/revox/version.rb +1 -1
- data/lib/revox.rb +0 -2
- data/rbi/revox/internal/util.rbi +8 -0
- data/rbi/revox/models/assistant_create_params.rbi +2138 -103
- data/rbi/revox/models/assistant_create_response.rbi +2454 -199
- data/rbi/revox/models/assistant_list_response.rbi +2448 -195
- data/rbi/revox/models/assistant_retrieve_response.rbi +2401 -210
- data/rbi/revox/models/assistant_update_params.rbi +2138 -103
- data/rbi/revox/models/assistant_update_response.rbi +2504 -198
- data/rbi/revox/models/call_create_params.rbi +2382 -225
- data/rbi/revox/models/call_create_response.rbi +4104 -384
- data/rbi/revox/models/call_retrieve_response.rbi +4104 -382
- data/rbi/revox/models/campaign_create_params.rbi +136 -0
- data/rbi/revox/models/campaign_create_response.rbi +2911 -231
- data/rbi/revox/models/campaign_get_rows_params.rbi +2 -82
- data/rbi/revox/models/campaign_get_rows_response.rbi +4135 -410
- data/rbi/revox/models/campaign_list_response.rbi +2904 -230
- data/rbi/revox/models/campaign_retrieve_response.rbi +2911 -231
- data/rbi/revox/models/users/me_retrieve_response.rbi +13 -3
- data/rbi/revox/models/users/me_update_response.rbi +13 -3
- data/rbi/revox/models/voice_list_response.rbi +105 -3
- data/rbi/revox/models/voice_preview_params.rbi +69 -0
- data/rbi/revox/models.rbi +0 -2
- data/rbi/revox/resources/assistants.rbi +284 -8
- data/rbi/revox/resources/call.rbi +0 -21
- data/rbi/revox/resources/campaigns.rbi +12 -19
- data/rbi/revox/resources/voices.rbi +17 -9
- data/sig/revox/internal/util.rbs +4 -0
- data/sig/revox/models/assistant_create_params.rbs +844 -11
- data/sig/revox/models/assistant_create_response.rbs +860 -3
- data/sig/revox/models/assistant_list_response.rbs +860 -3
- data/sig/revox/models/assistant_retrieve_response.rbs +859 -3
- data/sig/revox/models/assistant_update_params.rbs +844 -11
- data/sig/revox/models/assistant_update_response.rbs +886 -6
- data/sig/revox/models/call_create_params.rbs +847 -13
- data/sig/revox/models/call_create_response.rbs +1514 -34
- data/sig/revox/models/call_retrieve_response.rbs +1514 -34
- data/sig/revox/models/campaign_create_params.rbs +54 -0
- data/sig/revox/models/campaign_create_response.rbs +1034 -6
- data/sig/revox/models/campaign_get_rows_params.rbs +2 -64
- data/sig/revox/models/campaign_get_rows_response.rbs +1522 -54
- data/sig/revox/models/campaign_list_response.rbs +1034 -6
- data/sig/revox/models/campaign_retrieve_response.rbs +1034 -6
- data/sig/revox/models/users/me_retrieve_response.rbs +8 -3
- data/sig/revox/models/users/me_update_response.rbs +8 -3
- data/sig/revox/models/voice_list_response.rbs +45 -3
- data/sig/revox/models/voice_preview_params.rbs +42 -1
- data/sig/revox/models.rbs +0 -2
- data/sig/revox/resources/assistants.rbs +56 -2
- data/sig/revox/resources/call.rbs +0 -7
- data/sig/revox/resources/campaigns.rbs +2 -5
- data/sig/revox/resources/voices.rbs +4 -0
- metadata +2 -8
- data/lib/revox/models/call_list_params.rb +0 -52
- data/lib/revox/models/call_list_response.rb +0 -259
- data/rbi/revox/models/call_list_params.rbi +0 -94
- data/rbi/revox/models/call_list_response.rbi +0 -563
- data/sig/revox/models/call_list_params.rbs +0 -63
- data/sig/revox/models/call_list_response.rbs +0 -226
|
@@ -19,15 +19,36 @@ module Revox
|
|
|
19
19
|
# @return [String]
|
|
20
20
|
required :id, String
|
|
21
21
|
|
|
22
|
+
# @!attribute after_call_sms_outcomes
|
|
23
|
+
# Which call outcomes trigger the after-call SMS. When empty or null, no
|
|
24
|
+
# after-call SMS is sent. Use "none" when outcome is null.
|
|
25
|
+
#
|
|
26
|
+
# @return [Array<Symbol, Revox::Models::AssistantCreateResponse::Assistant::AfterCallSMSOutcome>, nil]
|
|
27
|
+
required :after_call_sms_outcomes,
|
|
28
|
+
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::AssistantCreateResponse::Assistant::AfterCallSMSOutcome] },
|
|
29
|
+
nil?: true
|
|
30
|
+
|
|
31
|
+
# @!attribute after_call_sms_prompt
|
|
32
|
+
# Prompt / instructions for the after-call SMS. Supports {{variable}}
|
|
33
|
+
# placeholders. When null, no after-call SMS is sent.
|
|
34
|
+
#
|
|
35
|
+
# @return [String, nil]
|
|
36
|
+
required :after_call_sms_prompt, String, nil?: true
|
|
37
|
+
|
|
22
38
|
# @!attribute background_sound
|
|
23
|
-
#
|
|
24
|
-
# your AI agent is in an office.
|
|
39
|
+
# Ambient background sound to play during the call. null disables it.
|
|
25
40
|
#
|
|
26
41
|
# @return [Symbol, Revox::Models::AssistantCreateResponse::Assistant::BackgroundSound, nil]
|
|
27
42
|
required :background_sound,
|
|
28
43
|
enum: -> { Revox::Models::AssistantCreateResponse::Assistant::BackgroundSound },
|
|
29
44
|
nil?: true
|
|
30
45
|
|
|
46
|
+
# @!attribute background_sound_volume
|
|
47
|
+
# Volume of the ambient background sound (0 = silent, 1 = max).
|
|
48
|
+
#
|
|
49
|
+
# @return [Float]
|
|
50
|
+
required :background_sound_volume, Float
|
|
51
|
+
|
|
31
52
|
# @!attribute calendly
|
|
32
53
|
#
|
|
33
54
|
# @return [Revox::Models::AssistantCreateResponse::Assistant::Calendly, nil]
|
|
@@ -42,11 +63,48 @@ module Revox
|
|
|
42
63
|
-> { Revox::Models::AssistantCreateResponse::Assistant::CallRetryConfig },
|
|
43
64
|
nil?: true
|
|
44
65
|
|
|
66
|
+
# @!attribute cartesia_dictionary_pronunciation_id
|
|
67
|
+
# Optional Cartesia pronunciation dictionary ID linked to this assistant.
|
|
68
|
+
#
|
|
69
|
+
# @return [String, nil]
|
|
70
|
+
required :cartesia_dictionary_pronunciation_id, String, nil?: true
|
|
71
|
+
|
|
45
72
|
# @!attribute created_at
|
|
46
73
|
#
|
|
47
74
|
# @return [Object]
|
|
48
75
|
required :created_at, Revox::Internal::Type::Unknown
|
|
49
76
|
|
|
77
|
+
# @!attribute custom_tools
|
|
78
|
+
#
|
|
79
|
+
# @return [Array<Revox::Models::AssistantCreateResponse::Assistant::CustomTool>, nil]
|
|
80
|
+
required :custom_tools,
|
|
81
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantCreateResponse::Assistant::CustomTool] },
|
|
82
|
+
nil?: true
|
|
83
|
+
|
|
84
|
+
# @!attribute email_notification_address
|
|
85
|
+
# Email address(es) to receive notifications when a call ends with a matching
|
|
86
|
+
# outcome. Accepts a single email or a comma-separated list (e.g. "alice@x.com,
|
|
87
|
+
# bob@y.com").
|
|
88
|
+
#
|
|
89
|
+
# @return [String, nil]
|
|
90
|
+
required :email_notification_address, String, nil?: true
|
|
91
|
+
|
|
92
|
+
# @!attribute email_notification_language
|
|
93
|
+
# The language used for the notification email content. One of "en" or "fr".
|
|
94
|
+
#
|
|
95
|
+
# @return [Symbol, Revox::Models::AssistantCreateResponse::Assistant::EmailNotificationLanguage]
|
|
96
|
+
required :email_notification_language,
|
|
97
|
+
enum: -> { Revox::Models::AssistantCreateResponse::Assistant::EmailNotificationLanguage }
|
|
98
|
+
|
|
99
|
+
# @!attribute email_notification_outcomes
|
|
100
|
+
# Which call outcomes trigger an email notification. E.g. ["interested",
|
|
101
|
+
# "completed", "none"]. Use "none" when outcome is null.
|
|
102
|
+
#
|
|
103
|
+
# @return [Array<Symbol, Revox::Models::AssistantCreateResponse::Assistant::EmailNotificationOutcome>, nil]
|
|
104
|
+
required :email_notification_outcomes,
|
|
105
|
+
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::AssistantCreateResponse::Assistant::EmailNotificationOutcome] },
|
|
106
|
+
nil?: true
|
|
107
|
+
|
|
50
108
|
# @!attribute end_of_call_sentence
|
|
51
109
|
#
|
|
52
110
|
# @return [String, nil]
|
|
@@ -69,6 +127,22 @@ module Revox
|
|
|
69
127
|
required :first_sentence_mode,
|
|
70
128
|
enum: -> { Revox::Models::AssistantCreateResponse::Assistant::FirstSentenceMode }
|
|
71
129
|
|
|
130
|
+
# @!attribute from_phone_number
|
|
131
|
+
# Override the default outbound phone number for calls placed with this assistant.
|
|
132
|
+
# When null, the organization's default phone number is used.
|
|
133
|
+
#
|
|
134
|
+
# @return [String, nil]
|
|
135
|
+
required :from_phone_number, String, nil?: true
|
|
136
|
+
|
|
137
|
+
# @!attribute human_transfer_mode
|
|
138
|
+
# Warm or cold transfer when transfer_phone_number is set; null when transfer is
|
|
139
|
+
# not configured.
|
|
140
|
+
#
|
|
141
|
+
# @return [Symbol, Revox::Models::AssistantCreateResponse::Assistant::HumanTransferMode, nil]
|
|
142
|
+
required :human_transfer_mode,
|
|
143
|
+
enum: -> { Revox::Models::AssistantCreateResponse::Assistant::HumanTransferMode },
|
|
144
|
+
nil?: true
|
|
145
|
+
|
|
72
146
|
# @!attribute ivr_navigation_enabled
|
|
73
147
|
# Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
|
|
74
148
|
# skip turns to navigate phone menus.
|
|
@@ -78,9 +152,16 @@ module Revox
|
|
|
78
152
|
|
|
79
153
|
# @!attribute llm_model
|
|
80
154
|
#
|
|
81
|
-
# @return [Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember0, Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember1]
|
|
155
|
+
# @return [Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember0, Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember1, Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember2, Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember3]
|
|
82
156
|
required :llm_model, union: -> { Revox::Models::AssistantCreateResponse::Assistant::LlmModel }
|
|
83
157
|
|
|
158
|
+
# @!attribute logo_url
|
|
159
|
+
# Public URL of the brand logo shown on the assistant's demo page. Null when
|
|
160
|
+
# unset.
|
|
161
|
+
#
|
|
162
|
+
# @return [String, nil]
|
|
163
|
+
required :logo_url, String, nil?: true
|
|
164
|
+
|
|
84
165
|
# @!attribute max_call_duration_secs
|
|
85
166
|
# The maximum duration of the call in seconds. This is the maximum time the call
|
|
86
167
|
# will be allowed to run.
|
|
@@ -88,6 +169,14 @@ module Revox
|
|
|
88
169
|
# @return [Float]
|
|
89
170
|
required :max_call_duration_secs, Float
|
|
90
171
|
|
|
172
|
+
# @!attribute max_duration_end_message
|
|
173
|
+
# Optional message the agent will say, without being interruptible, when the call
|
|
174
|
+
# reaches its max duration. Kept short so it fits inside the farewell buffer. If
|
|
175
|
+
# null, the call ends silently.
|
|
176
|
+
#
|
|
177
|
+
# @return [String, nil]
|
|
178
|
+
required :max_duration_end_message, String, nil?: true
|
|
179
|
+
|
|
91
180
|
# @!attribute name
|
|
92
181
|
#
|
|
93
182
|
# @return [String]
|
|
@@ -98,11 +187,41 @@ module Revox
|
|
|
98
187
|
# @return [String]
|
|
99
188
|
required :organization_id, String
|
|
100
189
|
|
|
190
|
+
# @!attribute position
|
|
191
|
+
#
|
|
192
|
+
# @return [Revox::Models::AssistantCreateResponse::Assistant::Position, nil]
|
|
193
|
+
required :position, -> { Revox::Models::AssistantCreateResponse::Assistant::Position }, nil?: true
|
|
194
|
+
|
|
101
195
|
# @!attribute prompt
|
|
102
196
|
#
|
|
103
197
|
# @return [String]
|
|
104
198
|
required :prompt, String
|
|
105
199
|
|
|
200
|
+
# @!attribute prompt_flow
|
|
201
|
+
#
|
|
202
|
+
# @return [Revox::Models::AssistantCreateResponse::Assistant::PromptFlow, nil]
|
|
203
|
+
required :prompt_flow, -> { Revox::Models::AssistantCreateResponse::Assistant::PromptFlow }, nil?: true
|
|
204
|
+
|
|
205
|
+
# @!attribute slack
|
|
206
|
+
#
|
|
207
|
+
# @return [Revox::Models::AssistantCreateResponse::Assistant::Slack, nil]
|
|
208
|
+
required :slack, -> { Revox::Models::AssistantCreateResponse::Assistant::Slack }, nil?: true
|
|
209
|
+
|
|
210
|
+
# @!attribute sms_enabled
|
|
211
|
+
# Enable SMS tool during calls. When enabled, the agent can send SMS messages to
|
|
212
|
+
# the user on the call.
|
|
213
|
+
#
|
|
214
|
+
# @return [Boolean]
|
|
215
|
+
required :sms_enabled, Revox::Internal::Type::Boolean
|
|
216
|
+
|
|
217
|
+
# @!attribute sms_template
|
|
218
|
+
# Hardcoded SMS template to send during calls. When set, this exact text is sent
|
|
219
|
+
# instead of letting the agent generate the message. Supports {{variable}}
|
|
220
|
+
# placeholders.
|
|
221
|
+
#
|
|
222
|
+
# @return [String, nil]
|
|
223
|
+
required :sms_template, String, nil?: true
|
|
224
|
+
|
|
106
225
|
# @!attribute structured_output_config
|
|
107
226
|
# The structured output config to use for the call. This is used to extract the
|
|
108
227
|
# data from the call (like email, name, company name, etc.).
|
|
@@ -112,12 +231,61 @@ module Revox
|
|
|
112
231
|
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantCreateResponse::Assistant::StructuredOutputConfig] },
|
|
113
232
|
nil?: true
|
|
114
233
|
|
|
234
|
+
# @!attribute structured_output_prompt
|
|
235
|
+
# Custom prompt for structured data extraction. If not provided, a default prompt
|
|
236
|
+
# is used. Available variables: {{transcript}}, {{call_direction}},
|
|
237
|
+
# {{user_phone_number}}, {{agent_phone_number}}.
|
|
238
|
+
#
|
|
239
|
+
# @return [String, nil]
|
|
240
|
+
required :structured_output_prompt, String, nil?: true
|
|
241
|
+
|
|
242
|
+
# @!attribute stt_context
|
|
243
|
+
# Assistant-level speech-to-text context: structured `general` key/value pairs
|
|
244
|
+
# plus a list of domain `terms`. Prompt-derived context is merged in without
|
|
245
|
+
# replacing existing entries.
|
|
246
|
+
#
|
|
247
|
+
# @return [Revox::Models::AssistantCreateResponse::Assistant::SttContext, nil]
|
|
248
|
+
required :stt_context, -> { Revox::Models::AssistantCreateResponse::Assistant::SttContext }, nil?: true
|
|
249
|
+
|
|
250
|
+
# @!attribute stt_model
|
|
251
|
+
# Transcriber (speech-to-text) model used for the assistant.
|
|
252
|
+
#
|
|
253
|
+
# @return [Symbol, Revox::Models::AssistantCreateResponse::Assistant::SttModel]
|
|
254
|
+
required :stt_model, enum: -> { Revox::Models::AssistantCreateResponse::Assistant::SttModel }
|
|
255
|
+
|
|
256
|
+
# @!attribute thinking_sound
|
|
257
|
+
# Audio clip to play while the agent is processing a response. One of the built-in
|
|
258
|
+
# LiveKit audio clips; null disables it.
|
|
259
|
+
#
|
|
260
|
+
# @return [Symbol, Revox::Models::AssistantCreateResponse::Assistant::ThinkingSound, nil]
|
|
261
|
+
required :thinking_sound,
|
|
262
|
+
enum: -> { Revox::Models::AssistantCreateResponse::Assistant::ThinkingSound },
|
|
263
|
+
nil?: true
|
|
264
|
+
|
|
265
|
+
# @!attribute thinking_sound_probability
|
|
266
|
+
# Probability [0..1] that the thinking sound plays on any given turn; otherwise
|
|
267
|
+
# the agent is silent while thinking.
|
|
268
|
+
#
|
|
269
|
+
# @return [Float]
|
|
270
|
+
required :thinking_sound_probability, Float
|
|
271
|
+
|
|
272
|
+
# @!attribute thinking_sound_volume
|
|
273
|
+
# Volume of the thinking sound (0 = silent, 1 = max).
|
|
274
|
+
#
|
|
275
|
+
# @return [Float]
|
|
276
|
+
required :thinking_sound_volume, Float
|
|
277
|
+
|
|
115
278
|
# @!attribute transfer_phone_number
|
|
116
279
|
# Phone number to transfer calls to when users request to speak to a human agent.
|
|
117
280
|
#
|
|
118
281
|
# @return [String, nil]
|
|
119
282
|
required :transfer_phone_number, String, nil?: true
|
|
120
283
|
|
|
284
|
+
# @!attribute type
|
|
285
|
+
#
|
|
286
|
+
# @return [Symbol, Revox::Models::AssistantCreateResponse::Assistant::Type]
|
|
287
|
+
required :type, enum: -> { Revox::Models::AssistantCreateResponse::Assistant::Type }
|
|
288
|
+
|
|
121
289
|
# @!attribute updated_at
|
|
122
290
|
#
|
|
123
291
|
# @return [Object]
|
|
@@ -135,37 +303,83 @@ module Revox
|
|
|
135
303
|
# @return [String, nil]
|
|
136
304
|
required :voicemail_message, String, nil?: true
|
|
137
305
|
|
|
306
|
+
# @!attribute voicemail_sms_prompt
|
|
307
|
+
# Prompt / instructions for the voicemail SMS. Supports {{variable}} placeholders.
|
|
308
|
+
# When null, no SMS is sent on voicemail.
|
|
309
|
+
#
|
|
310
|
+
# @return [String, nil]
|
|
311
|
+
required :voicemail_sms_prompt, String, nil?: true
|
|
312
|
+
|
|
313
|
+
# @!attribute warm_transfer_summary_instructions
|
|
314
|
+
# Warm transfer only: instructions for the supervisor handoff summary; null when
|
|
315
|
+
# not configured or cold transfer.
|
|
316
|
+
#
|
|
317
|
+
# @return [String, nil]
|
|
318
|
+
required :warm_transfer_summary_instructions, String, nil?: true
|
|
319
|
+
|
|
138
320
|
# @!attribute webhook_url
|
|
139
321
|
# The webhook URL to call when the call is completed.
|
|
140
322
|
#
|
|
141
323
|
# @return [String, nil]
|
|
142
324
|
required :webhook_url, String, nil?: true
|
|
143
325
|
|
|
326
|
+
# @!attribute zoho
|
|
327
|
+
#
|
|
328
|
+
# @return [Revox::Models::AssistantCreateResponse::Assistant::Zoho, nil]
|
|
329
|
+
required :zoho, -> { Revox::Models::AssistantCreateResponse::Assistant::Zoho }, nil?: true
|
|
330
|
+
|
|
331
|
+
# @!attribute created_by
|
|
332
|
+
# The user who created the assistant.
|
|
333
|
+
#
|
|
334
|
+
# @return [Revox::Models::AssistantCreateResponse::Assistant::CreatedBy, nil]
|
|
335
|
+
optional :created_by, -> { Revox::Models::AssistantCreateResponse::Assistant::CreatedBy }, nil?: true
|
|
336
|
+
|
|
144
337
|
# @!attribute faq_items
|
|
145
338
|
#
|
|
146
339
|
# @return [Array<Revox::Models::AssistantCreateResponse::Assistant::FaqItem>, nil]
|
|
147
340
|
optional :faq_items,
|
|
148
341
|
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantCreateResponse::Assistant::FaqItem] }
|
|
149
342
|
|
|
343
|
+
# @!attribute is_realestate_assistant
|
|
344
|
+
#
|
|
345
|
+
# @return [Boolean, nil]
|
|
346
|
+
optional :is_realestate_assistant, Revox::Internal::Type::Boolean
|
|
347
|
+
|
|
150
348
|
# @!attribute pending_faq_count
|
|
151
349
|
#
|
|
152
350
|
# @return [Float, nil]
|
|
153
351
|
optional :pending_faq_count, Float
|
|
154
352
|
|
|
155
|
-
# @!method initialize(id:, background_sound:, calendly:, call_retry_config:, created_at:, end_of_call_sentence:, first_sentence:, first_sentence_delay_ms:, first_sentence_mode:, ivr_navigation_enabled:, llm_model:, max_call_duration_secs:, name:, organization_id:, prompt:, structured_output_config:, transfer_phone_number:, updated_at:, voice:, voicemail_message:, webhook_url:, faq_items: nil, pending_faq_count: nil)
|
|
353
|
+
# @!method initialize(id:, after_call_sms_outcomes:, after_call_sms_prompt:, background_sound:, background_sound_volume:, calendly:, call_retry_config:, cartesia_dictionary_pronunciation_id:, created_at:, custom_tools:, email_notification_address:, email_notification_language:, email_notification_outcomes:, end_of_call_sentence:, first_sentence:, first_sentence_delay_ms:, first_sentence_mode:, from_phone_number:, human_transfer_mode:, ivr_navigation_enabled:, llm_model:, logo_url:, max_call_duration_secs:, max_duration_end_message:, name:, organization_id:, position:, prompt:, prompt_flow:, slack:, sms_enabled:, sms_template:, structured_output_config:, structured_output_prompt:, stt_context:, stt_model:, thinking_sound:, thinking_sound_probability:, thinking_sound_volume:, transfer_phone_number:, type:, updated_at:, voice:, voicemail_message:, voicemail_sms_prompt:, warm_transfer_summary_instructions:, webhook_url:, zoho:, created_by: nil, faq_items: nil, is_realestate_assistant: nil, pending_faq_count: nil)
|
|
156
354
|
# Some parameter documentations has been truncated, see
|
|
157
355
|
# {Revox::Models::AssistantCreateResponse::Assistant} for more details.
|
|
158
356
|
#
|
|
159
357
|
# @param id [String]
|
|
160
358
|
#
|
|
161
|
-
# @param
|
|
359
|
+
# @param after_call_sms_outcomes [Array<Symbol, Revox::Models::AssistantCreateResponse::Assistant::AfterCallSMSOutcome>, nil] Which call outcomes trigger the after-call SMS. When empty or null, no after-cal
|
|
360
|
+
#
|
|
361
|
+
# @param after_call_sms_prompt [String, nil] Prompt / instructions for the after-call SMS. Supports {{variable}} placeholders
|
|
362
|
+
#
|
|
363
|
+
# @param background_sound [Symbol, Revox::Models::AssistantCreateResponse::Assistant::BackgroundSound, nil] Ambient background sound to play during the call. null disables it.
|
|
364
|
+
#
|
|
365
|
+
# @param background_sound_volume [Float] Volume of the ambient background sound (0 = silent, 1 = max).
|
|
162
366
|
#
|
|
163
367
|
# @param calendly [Revox::Models::AssistantCreateResponse::Assistant::Calendly, nil]
|
|
164
368
|
#
|
|
165
369
|
# @param call_retry_config [Revox::Models::AssistantCreateResponse::Assistant::CallRetryConfig, nil] Configuration for call retry behavior including time windows, delays, and max it
|
|
166
370
|
#
|
|
371
|
+
# @param cartesia_dictionary_pronunciation_id [String, nil] Optional Cartesia pronunciation dictionary ID linked to this assistant.
|
|
372
|
+
#
|
|
167
373
|
# @param created_at [Object]
|
|
168
374
|
#
|
|
375
|
+
# @param custom_tools [Array<Revox::Models::AssistantCreateResponse::Assistant::CustomTool>, nil]
|
|
376
|
+
#
|
|
377
|
+
# @param email_notification_address [String, nil] Email address(es) to receive notifications when a call ends with a matching outc
|
|
378
|
+
#
|
|
379
|
+
# @param email_notification_language [Symbol, Revox::Models::AssistantCreateResponse::Assistant::EmailNotificationLanguage] The language used for the notification email content. One of "en" or "fr".
|
|
380
|
+
#
|
|
381
|
+
# @param email_notification_outcomes [Array<Symbol, Revox::Models::AssistantCreateResponse::Assistant::EmailNotificationOutcome>, nil] Which call outcomes trigger an email notification. E.g. ["interested", "complete
|
|
382
|
+
#
|
|
169
383
|
# @param end_of_call_sentence [String, nil]
|
|
170
384
|
#
|
|
171
385
|
# @param first_sentence [String, nil]
|
|
@@ -174,36 +388,93 @@ module Revox
|
|
|
174
388
|
#
|
|
175
389
|
# @param first_sentence_mode [Symbol, Revox::Models::AssistantCreateResponse::Assistant::FirstSentenceMode]
|
|
176
390
|
#
|
|
391
|
+
# @param from_phone_number [String, nil] Override the default outbound phone number for calls placed with this assistant.
|
|
392
|
+
#
|
|
393
|
+
# @param human_transfer_mode [Symbol, Revox::Models::AssistantCreateResponse::Assistant::HumanTransferMode, nil] Warm or cold transfer when transfer_phone_number is set; null when transfer is n
|
|
394
|
+
#
|
|
177
395
|
# @param ivr_navigation_enabled [Boolean] Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
|
|
178
396
|
#
|
|
179
|
-
# @param llm_model [Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember0, Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember1]
|
|
397
|
+
# @param llm_model [Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember0, Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember1, Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember2, Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember3]
|
|
398
|
+
#
|
|
399
|
+
# @param logo_url [String, nil] Public URL of the brand logo shown on the assistant's demo page. Null when unset
|
|
180
400
|
#
|
|
181
401
|
# @param max_call_duration_secs [Float] The maximum duration of the call in seconds. This is the maximum time the call w
|
|
182
402
|
#
|
|
403
|
+
# @param max_duration_end_message [String, nil] Optional message the agent will say, without being interruptible, when the call
|
|
404
|
+
#
|
|
183
405
|
# @param name [String]
|
|
184
406
|
#
|
|
185
407
|
# @param organization_id [String]
|
|
186
408
|
#
|
|
409
|
+
# @param position [Revox::Models::AssistantCreateResponse::Assistant::Position, nil]
|
|
410
|
+
#
|
|
187
411
|
# @param prompt [String]
|
|
188
412
|
#
|
|
413
|
+
# @param prompt_flow [Revox::Models::AssistantCreateResponse::Assistant::PromptFlow, nil]
|
|
414
|
+
#
|
|
415
|
+
# @param slack [Revox::Models::AssistantCreateResponse::Assistant::Slack, nil]
|
|
416
|
+
#
|
|
417
|
+
# @param sms_enabled [Boolean] Enable SMS tool during calls. When enabled, the agent can send SMS messages to t
|
|
418
|
+
#
|
|
419
|
+
# @param sms_template [String, nil] Hardcoded SMS template to send during calls. When set, this exact text is sent i
|
|
420
|
+
#
|
|
189
421
|
# @param structured_output_config [Array<Revox::Models::AssistantCreateResponse::Assistant::StructuredOutputConfig>, nil] The structured output config to use for the call. This is used to extract the da
|
|
190
422
|
#
|
|
423
|
+
# @param structured_output_prompt [String, nil] Custom prompt for structured data extraction. If not provided, a default prompt
|
|
424
|
+
#
|
|
425
|
+
# @param stt_context [Revox::Models::AssistantCreateResponse::Assistant::SttContext, nil] Assistant-level speech-to-text context: structured `general` key/value pairs plu
|
|
426
|
+
#
|
|
427
|
+
# @param stt_model [Symbol, Revox::Models::AssistantCreateResponse::Assistant::SttModel] Transcriber (speech-to-text) model used for the assistant.
|
|
428
|
+
#
|
|
429
|
+
# @param thinking_sound [Symbol, Revox::Models::AssistantCreateResponse::Assistant::ThinkingSound, nil] Audio clip to play while the agent is processing a response. One of the built-in
|
|
430
|
+
#
|
|
431
|
+
# @param thinking_sound_probability [Float] Probability [0..1] that the thinking sound plays on any given turn; otherwise th
|
|
432
|
+
#
|
|
433
|
+
# @param thinking_sound_volume [Float] Volume of the thinking sound (0 = silent, 1 = max).
|
|
434
|
+
#
|
|
191
435
|
# @param transfer_phone_number [String, nil] Phone number to transfer calls to when users request to speak to a human agent.
|
|
192
436
|
#
|
|
437
|
+
# @param type [Symbol, Revox::Models::AssistantCreateResponse::Assistant::Type]
|
|
438
|
+
#
|
|
193
439
|
# @param updated_at [Object]
|
|
194
440
|
#
|
|
195
441
|
# @param voice [Revox::Models::AssistantCreateResponse::Assistant::Voice, nil]
|
|
196
442
|
#
|
|
197
443
|
# @param voicemail_message [String, nil] If set, when voicemail is detected the agent will speak this message then hang u
|
|
198
444
|
#
|
|
445
|
+
# @param voicemail_sms_prompt [String, nil] Prompt / instructions for the voicemail SMS. Supports {{variable}} placeholders.
|
|
446
|
+
#
|
|
447
|
+
# @param warm_transfer_summary_instructions [String, nil] Warm transfer only: instructions for the supervisor handoff summary; null when n
|
|
448
|
+
#
|
|
199
449
|
# @param webhook_url [String, nil] The webhook URL to call when the call is completed.
|
|
200
450
|
#
|
|
451
|
+
# @param zoho [Revox::Models::AssistantCreateResponse::Assistant::Zoho, nil]
|
|
452
|
+
#
|
|
453
|
+
# @param created_by [Revox::Models::AssistantCreateResponse::Assistant::CreatedBy, nil] The user who created the assistant.
|
|
454
|
+
#
|
|
201
455
|
# @param faq_items [Array<Revox::Models::AssistantCreateResponse::Assistant::FaqItem>]
|
|
202
456
|
#
|
|
457
|
+
# @param is_realestate_assistant [Boolean]
|
|
458
|
+
#
|
|
203
459
|
# @param pending_faq_count [Float]
|
|
204
460
|
|
|
205
|
-
|
|
206
|
-
|
|
461
|
+
module AfterCallSMSOutcome
|
|
462
|
+
extend Revox::Internal::Type::Enum
|
|
463
|
+
|
|
464
|
+
NOT_INTERESTED = :not_interested
|
|
465
|
+
INTERESTED = :interested
|
|
466
|
+
COMPLETED = :completed
|
|
467
|
+
REQUESTED_CALLBACK_LATER = :requested_callback_later
|
|
468
|
+
REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
|
|
469
|
+
DO_NOT_CONTACT = :do_not_contact
|
|
470
|
+
AI_AVERSE = :ai_averse
|
|
471
|
+
NONE = :none
|
|
472
|
+
|
|
473
|
+
# @!method self.values
|
|
474
|
+
# @return [Array<Symbol>]
|
|
475
|
+
end
|
|
476
|
+
|
|
477
|
+
# Ambient background sound to play during the call. null disables it.
|
|
207
478
|
#
|
|
208
479
|
# @see Revox::Models::AssistantCreateResponse::Assistant#background_sound
|
|
209
480
|
module BackgroundSound
|
|
@@ -241,6 +512,23 @@ module Revox
|
|
|
241
512
|
|
|
242
513
|
# @see Revox::Models::AssistantCreateResponse::Assistant#call_retry_config
|
|
243
514
|
class CallRetryConfig < Revox::Internal::Type::BaseModel
|
|
515
|
+
# @!attribute allowed_days
|
|
516
|
+
# Days of the week when calls are allowed, in the recipient's timezone. Default:
|
|
517
|
+
# Monday through Friday.
|
|
518
|
+
#
|
|
519
|
+
# @return [Array<Symbol, Revox::Models::AssistantCreateResponse::Assistant::CallRetryConfig::AllowedDay>]
|
|
520
|
+
required :allowed_days,
|
|
521
|
+
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::AssistantCreateResponse::Assistant::CallRetryConfig::AllowedDay] }
|
|
522
|
+
|
|
523
|
+
# @!attribute call_twice_in_a_row
|
|
524
|
+
# If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping
|
|
525
|
+
# retry_delay_seconds) when attempt #1 didn't reach a human.
|
|
526
|
+
# Calling-window/allowed-days checks still apply. Only affects the 1→2 transition.
|
|
527
|
+
# Default: false.
|
|
528
|
+
#
|
|
529
|
+
# @return [Boolean]
|
|
530
|
+
required :call_twice_in_a_row, Revox::Internal::Type::Boolean
|
|
531
|
+
|
|
244
532
|
# @!attribute calling_windows
|
|
245
533
|
#
|
|
246
534
|
# @return [Array<Revox::Models::AssistantCreateResponse::Assistant::CallRetryConfig::CallingWindow>]
|
|
@@ -261,7 +549,7 @@ module Revox
|
|
|
261
549
|
# @return [String, nil]
|
|
262
550
|
optional :timezone, String, nil?: true
|
|
263
551
|
|
|
264
|
-
# @!method initialize(calling_windows:, max_retry_attempts:, timezone: nil)
|
|
552
|
+
# @!method initialize(allowed_days:, call_twice_in_a_row:, calling_windows:, max_retry_attempts:, timezone: nil)
|
|
265
553
|
# Some parameter documentations has been truncated, see
|
|
266
554
|
# {Revox::Models::AssistantCreateResponse::Assistant::CallRetryConfig} for more
|
|
267
555
|
# details.
|
|
@@ -269,12 +557,31 @@ module Revox
|
|
|
269
557
|
# Configuration for call retry behavior including time windows, delays, and max
|
|
270
558
|
# iterations. If not provided, defaults will be used.
|
|
271
559
|
#
|
|
560
|
+
# @param allowed_days [Array<Symbol, Revox::Models::AssistantCreateResponse::Assistant::CallRetryConfig::AllowedDay>] Days of the week when calls are allowed, in the recipient's timezone. Default: M
|
|
561
|
+
#
|
|
562
|
+
# @param call_twice_in_a_row [Boolean] If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retr
|
|
563
|
+
#
|
|
272
564
|
# @param calling_windows [Array<Revox::Models::AssistantCreateResponse::Assistant::CallRetryConfig::CallingWindow>]
|
|
273
565
|
#
|
|
274
566
|
# @param max_retry_attempts [Integer] Maximum number of call retry attempts. Default: 3.
|
|
275
567
|
#
|
|
276
568
|
# @param timezone [String, nil] Optional IANA timezone identifier to override the automatic timezone detection f
|
|
277
569
|
|
|
570
|
+
module AllowedDay
|
|
571
|
+
extend Revox::Internal::Type::Enum
|
|
572
|
+
|
|
573
|
+
MONDAY = :monday
|
|
574
|
+
TUESDAY = :tuesday
|
|
575
|
+
WEDNESDAY = :wednesday
|
|
576
|
+
THURSDAY = :thursday
|
|
577
|
+
FRIDAY = :friday
|
|
578
|
+
SATURDAY = :saturday
|
|
579
|
+
SUNDAY = :sunday
|
|
580
|
+
|
|
581
|
+
# @!method self.values
|
|
582
|
+
# @return [Array<Symbol>]
|
|
583
|
+
end
|
|
584
|
+
|
|
278
585
|
class CallingWindow < Revox::Internal::Type::BaseModel
|
|
279
586
|
# @!attribute calling_window_end_time
|
|
280
587
|
# End time for the calling window in the recipient's timezone (or
|
|
@@ -311,6 +618,214 @@ module Revox
|
|
|
311
618
|
end
|
|
312
619
|
end
|
|
313
620
|
|
|
621
|
+
class CustomTool < Revox::Internal::Type::BaseModel
|
|
622
|
+
# @!attribute body_template
|
|
623
|
+
# JSON body template for the request. Use quoted {{variable}} placeholders (e.g.
|
|
624
|
+
# "{{name}}") for dynamic values
|
|
625
|
+
#
|
|
626
|
+
# @return [String, nil]
|
|
627
|
+
required :body_template, String, nil?: true
|
|
628
|
+
|
|
629
|
+
# @!attribute description
|
|
630
|
+
# Human-readable description of what the tool does, used by the LLM to decide when
|
|
631
|
+
# to call it
|
|
632
|
+
#
|
|
633
|
+
# @return [String]
|
|
634
|
+
required :description, String
|
|
635
|
+
|
|
636
|
+
# @!attribute headers
|
|
637
|
+
# HTTP headers to include in the request. Values support {{variable}} placeholders
|
|
638
|
+
#
|
|
639
|
+
# @return [Array<Revox::Models::AssistantCreateResponse::Assistant::CustomTool::Header>]
|
|
640
|
+
required :headers,
|
|
641
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantCreateResponse::Assistant::CustomTool::Header] }
|
|
642
|
+
|
|
643
|
+
# @!attribute input_schema
|
|
644
|
+
# Schema defining the parameters the LLM should extract from the conversation to
|
|
645
|
+
# pass to this tool
|
|
646
|
+
#
|
|
647
|
+
# @return [Array<Revox::Models::AssistantCreateResponse::Assistant::CustomTool::InputSchema>]
|
|
648
|
+
required :input_schema,
|
|
649
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantCreateResponse::Assistant::CustomTool::InputSchema] }
|
|
650
|
+
|
|
651
|
+
# @!attribute method_
|
|
652
|
+
# HTTP method to use when calling the API endpoint
|
|
653
|
+
#
|
|
654
|
+
# @return [Symbol, Revox::Models::AssistantCreateResponse::Assistant::CustomTool::Method]
|
|
655
|
+
required :method_,
|
|
656
|
+
enum: -> { Revox::Models::AssistantCreateResponse::Assistant::CustomTool::Method },
|
|
657
|
+
api_name: :method
|
|
658
|
+
|
|
659
|
+
# @!attribute name
|
|
660
|
+
# Unique tool name in lowercase_snake_case (e.g. check_inventory)
|
|
661
|
+
#
|
|
662
|
+
# @return [String]
|
|
663
|
+
required :name, String
|
|
664
|
+
|
|
665
|
+
# @!attribute query_params
|
|
666
|
+
# Query string parameters appended to the URL. Values support {{variable}}
|
|
667
|
+
# placeholders
|
|
668
|
+
#
|
|
669
|
+
# @return [Array<Revox::Models::AssistantCreateResponse::Assistant::CustomTool::QueryParam>]
|
|
670
|
+
required :query_params,
|
|
671
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantCreateResponse::Assistant::CustomTool::QueryParam] }
|
|
672
|
+
|
|
673
|
+
# @!attribute url
|
|
674
|
+
# Full URL of the API endpoint. Supports {{variable}} placeholders for dynamic
|
|
675
|
+
# values
|
|
676
|
+
#
|
|
677
|
+
# @return [String]
|
|
678
|
+
required :url, String
|
|
679
|
+
|
|
680
|
+
# @!method initialize(body_template:, description:, headers:, input_schema:, method_:, name:, query_params:, url:)
|
|
681
|
+
# Some parameter documentations has been truncated, see
|
|
682
|
+
# {Revox::Models::AssistantCreateResponse::Assistant::CustomTool} for more
|
|
683
|
+
# details.
|
|
684
|
+
#
|
|
685
|
+
# @param body_template [String, nil] JSON body template for the request. Use quoted {{variable}} placeholders (e.g. "
|
|
686
|
+
#
|
|
687
|
+
# @param description [String] Human-readable description of what the tool does, used by the LLM to decide when
|
|
688
|
+
#
|
|
689
|
+
# @param headers [Array<Revox::Models::AssistantCreateResponse::Assistant::CustomTool::Header>] HTTP headers to include in the request. Values support {{variable}} placeholders
|
|
690
|
+
#
|
|
691
|
+
# @param input_schema [Array<Revox::Models::AssistantCreateResponse::Assistant::CustomTool::InputSchema>] Schema defining the parameters the LLM should extract from the conversation to p
|
|
692
|
+
#
|
|
693
|
+
# @param method_ [Symbol, Revox::Models::AssistantCreateResponse::Assistant::CustomTool::Method] HTTP method to use when calling the API endpoint
|
|
694
|
+
#
|
|
695
|
+
# @param name [String] Unique tool name in lowercase_snake_case (e.g. check_inventory)
|
|
696
|
+
#
|
|
697
|
+
# @param query_params [Array<Revox::Models::AssistantCreateResponse::Assistant::CustomTool::QueryParam>] Query string parameters appended to the URL. Values support {{variable}} placeho
|
|
698
|
+
#
|
|
699
|
+
# @param url [String] Full URL of the API endpoint. Supports {{variable}} placeholders for dynamic val
|
|
700
|
+
|
|
701
|
+
class Header < Revox::Internal::Type::BaseModel
|
|
702
|
+
# @!attribute key
|
|
703
|
+
#
|
|
704
|
+
# @return [String]
|
|
705
|
+
required :key, String
|
|
706
|
+
|
|
707
|
+
# @!attribute value
|
|
708
|
+
#
|
|
709
|
+
# @return [String]
|
|
710
|
+
required :value, String
|
|
711
|
+
|
|
712
|
+
# @!method initialize(key:, value:)
|
|
713
|
+
# @param key [String]
|
|
714
|
+
# @param value [String]
|
|
715
|
+
end
|
|
716
|
+
|
|
717
|
+
class InputSchema < Revox::Internal::Type::BaseModel
|
|
718
|
+
# @!attribute name
|
|
719
|
+
#
|
|
720
|
+
# @return [String]
|
|
721
|
+
required :name, String
|
|
722
|
+
|
|
723
|
+
# @!attribute required
|
|
724
|
+
#
|
|
725
|
+
# @return [Boolean]
|
|
726
|
+
required :required, Revox::Internal::Type::Boolean
|
|
727
|
+
|
|
728
|
+
# @!attribute type
|
|
729
|
+
#
|
|
730
|
+
# @return [Symbol, Revox::Models::AssistantCreateResponse::Assistant::CustomTool::InputSchema::Type]
|
|
731
|
+
required :type,
|
|
732
|
+
enum: -> { Revox::Models::AssistantCreateResponse::Assistant::CustomTool::InputSchema::Type }
|
|
733
|
+
|
|
734
|
+
# @!attribute description
|
|
735
|
+
#
|
|
736
|
+
# @return [String, nil]
|
|
737
|
+
optional :description, String
|
|
738
|
+
|
|
739
|
+
# @!attribute enum_options
|
|
740
|
+
#
|
|
741
|
+
# @return [Array<String>, nil]
|
|
742
|
+
optional :enum_options, Revox::Internal::Type::ArrayOf[String]
|
|
743
|
+
|
|
744
|
+
# @!method initialize(name:, required:, type:, description: nil, enum_options: nil)
|
|
745
|
+
# @param name [String]
|
|
746
|
+
# @param required [Boolean]
|
|
747
|
+
# @param type [Symbol, Revox::Models::AssistantCreateResponse::Assistant::CustomTool::InputSchema::Type]
|
|
748
|
+
# @param description [String]
|
|
749
|
+
# @param enum_options [Array<String>]
|
|
750
|
+
|
|
751
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant::CustomTool::InputSchema#type
|
|
752
|
+
module Type
|
|
753
|
+
extend Revox::Internal::Type::Enum
|
|
754
|
+
|
|
755
|
+
STRING = :string
|
|
756
|
+
NUMBER = :number
|
|
757
|
+
BOOLEAN = :boolean
|
|
758
|
+
ENUM = :enum
|
|
759
|
+
DATE = :date
|
|
760
|
+
DATETIME = :datetime
|
|
761
|
+
|
|
762
|
+
# @!method self.values
|
|
763
|
+
# @return [Array<Symbol>]
|
|
764
|
+
end
|
|
765
|
+
end
|
|
766
|
+
|
|
767
|
+
# HTTP method to use when calling the API endpoint
|
|
768
|
+
#
|
|
769
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant::CustomTool#method_
|
|
770
|
+
module Method
|
|
771
|
+
extend Revox::Internal::Type::Enum
|
|
772
|
+
|
|
773
|
+
GET = :GET
|
|
774
|
+
POST = :POST
|
|
775
|
+
PUT = :PUT
|
|
776
|
+
PATCH = :PATCH
|
|
777
|
+
DELETE = :DELETE
|
|
778
|
+
|
|
779
|
+
# @!method self.values
|
|
780
|
+
# @return [Array<Symbol>]
|
|
781
|
+
end
|
|
782
|
+
|
|
783
|
+
class QueryParam < Revox::Internal::Type::BaseModel
|
|
784
|
+
# @!attribute key
|
|
785
|
+
#
|
|
786
|
+
# @return [String]
|
|
787
|
+
required :key, String
|
|
788
|
+
|
|
789
|
+
# @!attribute value
|
|
790
|
+
#
|
|
791
|
+
# @return [String]
|
|
792
|
+
required :value, String
|
|
793
|
+
|
|
794
|
+
# @!method initialize(key:, value:)
|
|
795
|
+
# @param key [String]
|
|
796
|
+
# @param value [String]
|
|
797
|
+
end
|
|
798
|
+
end
|
|
799
|
+
|
|
800
|
+
# The language used for the notification email content. One of "en" or "fr".
|
|
801
|
+
#
|
|
802
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant#email_notification_language
|
|
803
|
+
module EmailNotificationLanguage
|
|
804
|
+
extend Revox::Internal::Type::Enum
|
|
805
|
+
|
|
806
|
+
EN = :en
|
|
807
|
+
FR = :fr
|
|
808
|
+
|
|
809
|
+
# @!method self.values
|
|
810
|
+
# @return [Array<Symbol>]
|
|
811
|
+
end
|
|
812
|
+
|
|
813
|
+
module EmailNotificationOutcome
|
|
814
|
+
extend Revox::Internal::Type::Enum
|
|
815
|
+
|
|
816
|
+
NOT_INTERESTED = :not_interested
|
|
817
|
+
INTERESTED = :interested
|
|
818
|
+
COMPLETED = :completed
|
|
819
|
+
REQUESTED_CALLBACK_LATER = :requested_callback_later
|
|
820
|
+
REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
|
|
821
|
+
DO_NOT_CONTACT = :do_not_contact
|
|
822
|
+
AI_AVERSE = :ai_averse
|
|
823
|
+
NONE = :none
|
|
824
|
+
|
|
825
|
+
# @!method self.values
|
|
826
|
+
# @return [Array<Symbol>]
|
|
827
|
+
end
|
|
828
|
+
|
|
314
829
|
# @see Revox::Models::AssistantCreateResponse::Assistant#first_sentence_mode
|
|
315
830
|
module FirstSentenceMode
|
|
316
831
|
extend Revox::Internal::Type::Enum
|
|
@@ -323,6 +838,20 @@ module Revox
|
|
|
323
838
|
# @return [Array<Symbol>]
|
|
324
839
|
end
|
|
325
840
|
|
|
841
|
+
# Warm or cold transfer when transfer_phone_number is set; null when transfer is
|
|
842
|
+
# not configured.
|
|
843
|
+
#
|
|
844
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant#human_transfer_mode
|
|
845
|
+
module HumanTransferMode
|
|
846
|
+
extend Revox::Internal::Type::Enum
|
|
847
|
+
|
|
848
|
+
WARM = :warm
|
|
849
|
+
COLD = :cold
|
|
850
|
+
|
|
851
|
+
# @!method self.values
|
|
852
|
+
# @return [Array<Symbol>]
|
|
853
|
+
end
|
|
854
|
+
|
|
326
855
|
# @see Revox::Models::AssistantCreateResponse::Assistant#llm_model
|
|
327
856
|
module LlmModel
|
|
328
857
|
extend Revox::Internal::Type::Union
|
|
@@ -331,6 +860,10 @@ module Revox
|
|
|
331
860
|
|
|
332
861
|
variant -> { Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember1 }
|
|
333
862
|
|
|
863
|
+
variant -> { Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember2 }
|
|
864
|
+
|
|
865
|
+
variant -> { Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember3 }
|
|
866
|
+
|
|
334
867
|
class UnionMember0 < Revox::Internal::Type::BaseModel
|
|
335
868
|
# @!attribute name
|
|
336
869
|
#
|
|
@@ -386,8 +919,282 @@ module Revox
|
|
|
386
919
|
# @param type [Symbol, :openrouter] Use a model from OpenRouter.
|
|
387
920
|
end
|
|
388
921
|
|
|
922
|
+
class UnionMember2 < Revox::Internal::Type::BaseModel
|
|
923
|
+
# @!attribute api_key
|
|
924
|
+
# API key sent as Bearer token to the custom endpoint.
|
|
925
|
+
#
|
|
926
|
+
# @return [String]
|
|
927
|
+
required :api_key, String
|
|
928
|
+
|
|
929
|
+
# @!attribute api_url
|
|
930
|
+
# Base URL for the OpenAI-compatible API, e.g. https://api.together.xyz/v1
|
|
931
|
+
#
|
|
932
|
+
# @return [String]
|
|
933
|
+
required :api_url, String
|
|
934
|
+
|
|
935
|
+
# @!attribute model_name
|
|
936
|
+
# Model name as expected by the provider, e.g. meta-llama/llama-3-70b
|
|
937
|
+
#
|
|
938
|
+
# @return [String]
|
|
939
|
+
required :model_name, String
|
|
940
|
+
|
|
941
|
+
# @!attribute type
|
|
942
|
+
# OpenAI-compatible chat completions API (bring your own endpoint and key).
|
|
943
|
+
#
|
|
944
|
+
# @return [Symbol, :custom]
|
|
945
|
+
required :type, const: :custom
|
|
946
|
+
|
|
947
|
+
# @!method initialize(api_key:, api_url:, model_name:, type: :custom)
|
|
948
|
+
# @param api_key [String] API key sent as Bearer token to the custom endpoint.
|
|
949
|
+
#
|
|
950
|
+
# @param api_url [String] Base URL for the OpenAI-compatible API, e.g. https://api.together.xyz/v1
|
|
951
|
+
#
|
|
952
|
+
# @param model_name [String] Model name as expected by the provider, e.g. meta-llama/llama-3-70b
|
|
953
|
+
#
|
|
954
|
+
# @param type [Symbol, :custom] OpenAI-compatible chat completions API (bring your own endpoint and key).
|
|
955
|
+
end
|
|
956
|
+
|
|
957
|
+
class UnionMember3 < Revox::Internal::Type::BaseModel
|
|
958
|
+
# @!attribute provider
|
|
959
|
+
# The provider to use from Realtime. eg: openai, google.
|
|
960
|
+
#
|
|
961
|
+
# @return [Symbol, Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember3::Provider]
|
|
962
|
+
required :provider,
|
|
963
|
+
enum: -> { Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember3::Provider }
|
|
964
|
+
|
|
965
|
+
# @!attribute realtime_model_id
|
|
966
|
+
# The model ID to use from Realtime. eg: gpt-4.1
|
|
967
|
+
#
|
|
968
|
+
# @return [String]
|
|
969
|
+
required :realtime_model_id, String
|
|
970
|
+
|
|
971
|
+
# @!attribute type
|
|
972
|
+
# Use a model from Realtime.
|
|
973
|
+
#
|
|
974
|
+
# @return [Symbol, :realtime]
|
|
975
|
+
required :type, const: :realtime
|
|
976
|
+
|
|
977
|
+
# @!attribute realtime_voice_id
|
|
978
|
+
# Output voice for the realtime provider (e.g. OpenAI: marin; Gemini: Puck).
|
|
979
|
+
#
|
|
980
|
+
# @return [String, nil]
|
|
981
|
+
optional :realtime_voice_id, String
|
|
982
|
+
|
|
983
|
+
# @!method initialize(provider:, realtime_model_id:, realtime_voice_id: nil, type: :realtime)
|
|
984
|
+
# @param provider [Symbol, Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember3::Provider] The provider to use from Realtime. eg: openai, google.
|
|
985
|
+
#
|
|
986
|
+
# @param realtime_model_id [String] The model ID to use from Realtime. eg: gpt-4.1
|
|
987
|
+
#
|
|
988
|
+
# @param realtime_voice_id [String] Output voice for the realtime provider (e.g. OpenAI: marin; Gemini: Puck).
|
|
989
|
+
#
|
|
990
|
+
# @param type [Symbol, :realtime] Use a model from Realtime.
|
|
991
|
+
|
|
992
|
+
# The provider to use from Realtime. eg: openai, google.
|
|
993
|
+
#
|
|
994
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember3#provider
|
|
995
|
+
module Provider
|
|
996
|
+
extend Revox::Internal::Type::Enum
|
|
997
|
+
|
|
998
|
+
OPENAI = :openai
|
|
999
|
+
GOOGLE = :google
|
|
1000
|
+
|
|
1001
|
+
# @!method self.values
|
|
1002
|
+
# @return [Array<Symbol>]
|
|
1003
|
+
end
|
|
1004
|
+
end
|
|
1005
|
+
|
|
389
1006
|
# @!method self.variants
|
|
390
|
-
# @return [Array(Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember0, Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember1)]
|
|
1007
|
+
# @return [Array(Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember0, Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember1, Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember2, Revox::Models::AssistantCreateResponse::Assistant::LlmModel::UnionMember3)]
|
|
1008
|
+
end
|
|
1009
|
+
|
|
1010
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant#position
|
|
1011
|
+
class Position < Revox::Internal::Type::BaseModel
|
|
1012
|
+
# @!attribute x
|
|
1013
|
+
#
|
|
1014
|
+
# @return [Float]
|
|
1015
|
+
required :x, Float
|
|
1016
|
+
|
|
1017
|
+
# @!attribute y_
|
|
1018
|
+
#
|
|
1019
|
+
# @return [Float]
|
|
1020
|
+
required :y_, Float, api_name: :y
|
|
1021
|
+
|
|
1022
|
+
# @!method initialize(x:, y_:)
|
|
1023
|
+
# @param x [Float]
|
|
1024
|
+
# @param y_ [Float]
|
|
1025
|
+
end
|
|
1026
|
+
|
|
1027
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant#prompt_flow
|
|
1028
|
+
class PromptFlow < Revox::Internal::Type::BaseModel
|
|
1029
|
+
# @!attribute edges
|
|
1030
|
+
#
|
|
1031
|
+
# @return [Array<Revox::Models::AssistantCreateResponse::Assistant::PromptFlow::Edge>]
|
|
1032
|
+
required :edges,
|
|
1033
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantCreateResponse::Assistant::PromptFlow::Edge] }
|
|
1034
|
+
|
|
1035
|
+
# @!attribute nodes
|
|
1036
|
+
#
|
|
1037
|
+
# @return [Array<Revox::Models::AssistantCreateResponse::Assistant::PromptFlow::Node>]
|
|
1038
|
+
required :nodes,
|
|
1039
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantCreateResponse::Assistant::PromptFlow::Node] }
|
|
1040
|
+
|
|
1041
|
+
# @!method initialize(edges:, nodes:)
|
|
1042
|
+
# @param edges [Array<Revox::Models::AssistantCreateResponse::Assistant::PromptFlow::Edge>]
|
|
1043
|
+
# @param nodes [Array<Revox::Models::AssistantCreateResponse::Assistant::PromptFlow::Node>]
|
|
1044
|
+
|
|
1045
|
+
class Edge < Revox::Internal::Type::BaseModel
|
|
1046
|
+
# @!attribute id
|
|
1047
|
+
#
|
|
1048
|
+
# @return [String]
|
|
1049
|
+
required :id, String
|
|
1050
|
+
|
|
1051
|
+
# @!attribute source
|
|
1052
|
+
#
|
|
1053
|
+
# @return [String]
|
|
1054
|
+
required :source, String
|
|
1055
|
+
|
|
1056
|
+
# @!attribute target
|
|
1057
|
+
#
|
|
1058
|
+
# @return [String]
|
|
1059
|
+
required :target, String
|
|
1060
|
+
|
|
1061
|
+
# @!method initialize(id:, source:, target:)
|
|
1062
|
+
# @param id [String]
|
|
1063
|
+
# @param source [String]
|
|
1064
|
+
# @param target [String]
|
|
1065
|
+
end
|
|
1066
|
+
|
|
1067
|
+
class Node < Revox::Internal::Type::BaseModel
|
|
1068
|
+
# @!attribute id
|
|
1069
|
+
#
|
|
1070
|
+
# @return [String]
|
|
1071
|
+
required :id, String
|
|
1072
|
+
|
|
1073
|
+
# @!attribute data
|
|
1074
|
+
#
|
|
1075
|
+
# @return [Revox::Models::AssistantCreateResponse::Assistant::PromptFlow::Node::Data]
|
|
1076
|
+
required :data, -> { Revox::Models::AssistantCreateResponse::Assistant::PromptFlow::Node::Data }
|
|
1077
|
+
|
|
1078
|
+
# @!attribute position
|
|
1079
|
+
#
|
|
1080
|
+
# @return [Revox::Models::AssistantCreateResponse::Assistant::PromptFlow::Node::Position]
|
|
1081
|
+
required :position, -> { Revox::Models::AssistantCreateResponse::Assistant::PromptFlow::Node::Position }
|
|
1082
|
+
|
|
1083
|
+
# @!attribute type
|
|
1084
|
+
#
|
|
1085
|
+
# @return [Symbol, :promptBlock]
|
|
1086
|
+
required :type, const: :promptBlock
|
|
1087
|
+
|
|
1088
|
+
# @!method initialize(id:, data:, position:, type: :promptBlock)
|
|
1089
|
+
# @param id [String]
|
|
1090
|
+
# @param data [Revox::Models::AssistantCreateResponse::Assistant::PromptFlow::Node::Data]
|
|
1091
|
+
# @param position [Revox::Models::AssistantCreateResponse::Assistant::PromptFlow::Node::Position]
|
|
1092
|
+
# @param type [Symbol, :promptBlock]
|
|
1093
|
+
|
|
1094
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant::PromptFlow::Node#data
|
|
1095
|
+
class Data < Revox::Internal::Type::BaseModel
|
|
1096
|
+
# @!attribute body
|
|
1097
|
+
#
|
|
1098
|
+
# @return [String]
|
|
1099
|
+
required :body, String
|
|
1100
|
+
|
|
1101
|
+
# @!attribute title
|
|
1102
|
+
#
|
|
1103
|
+
# @return [String]
|
|
1104
|
+
required :title, String
|
|
1105
|
+
|
|
1106
|
+
# @!method initialize(body:, title:)
|
|
1107
|
+
# @param body [String]
|
|
1108
|
+
# @param title [String]
|
|
1109
|
+
end
|
|
1110
|
+
|
|
1111
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant::PromptFlow::Node#position
|
|
1112
|
+
class Position < Revox::Internal::Type::BaseModel
|
|
1113
|
+
# @!attribute x
|
|
1114
|
+
#
|
|
1115
|
+
# @return [Float]
|
|
1116
|
+
required :x, Float
|
|
1117
|
+
|
|
1118
|
+
# @!attribute y_
|
|
1119
|
+
#
|
|
1120
|
+
# @return [Float]
|
|
1121
|
+
required :y_, Float, api_name: :y
|
|
1122
|
+
|
|
1123
|
+
# @!method initialize(x:, y_:)
|
|
1124
|
+
# @param x [Float]
|
|
1125
|
+
# @param y_ [Float]
|
|
1126
|
+
end
|
|
1127
|
+
end
|
|
1128
|
+
end
|
|
1129
|
+
|
|
1130
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant#slack
|
|
1131
|
+
class Slack < Revox::Internal::Type::BaseModel
|
|
1132
|
+
# @!attribute channel_id
|
|
1133
|
+
# The Slack channel ID where the notification will be posted.
|
|
1134
|
+
#
|
|
1135
|
+
# @return [String]
|
|
1136
|
+
required :channel_id, String
|
|
1137
|
+
|
|
1138
|
+
# @!attribute connection_id
|
|
1139
|
+
# The Nango connection ID linking the org's Slack workspace to Revox.
|
|
1140
|
+
#
|
|
1141
|
+
# @return [String]
|
|
1142
|
+
required :connection_id, String
|
|
1143
|
+
|
|
1144
|
+
# @!attribute outcomes
|
|
1145
|
+
# Which call outcomes trigger a Slack notification (e.g. ['interested', 'none']).
|
|
1146
|
+
# Use 'none' to notify when outcome is null.
|
|
1147
|
+
#
|
|
1148
|
+
# @return [Array<Symbol, Revox::Models::AssistantCreateResponse::Assistant::Slack::Outcome>]
|
|
1149
|
+
required :outcomes,
|
|
1150
|
+
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::AssistantCreateResponse::Assistant::Slack::Outcome] }
|
|
1151
|
+
|
|
1152
|
+
# @!attribute channel_name
|
|
1153
|
+
# Human-readable Slack channel name, cached for display in the UI.
|
|
1154
|
+
#
|
|
1155
|
+
# @return [String, nil]
|
|
1156
|
+
optional :channel_name, String, nil?: true
|
|
1157
|
+
|
|
1158
|
+
# @!attribute template
|
|
1159
|
+
# Optional message template. Supports {{summary}}, {{outcome}}, {{phone}},
|
|
1160
|
+
# {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{first_name}},
|
|
1161
|
+
# {{last_name}}, {{email}}, {{company}}, {{contact_name}}, {{contact_line}}, plus
|
|
1162
|
+
# prompt_variables and structured_output keys. When null/empty a default template
|
|
1163
|
+
# is used.
|
|
1164
|
+
#
|
|
1165
|
+
# @return [String, nil]
|
|
1166
|
+
optional :template, String, nil?: true
|
|
1167
|
+
|
|
1168
|
+
# @!method initialize(channel_id:, connection_id:, outcomes:, channel_name: nil, template: nil)
|
|
1169
|
+
# Some parameter documentations has been truncated, see
|
|
1170
|
+
# {Revox::Models::AssistantCreateResponse::Assistant::Slack} for more details.
|
|
1171
|
+
#
|
|
1172
|
+
# @param channel_id [String] The Slack channel ID where the notification will be posted.
|
|
1173
|
+
#
|
|
1174
|
+
# @param connection_id [String] The Nango connection ID linking the org's Slack workspace to Revox.
|
|
1175
|
+
#
|
|
1176
|
+
# @param outcomes [Array<Symbol, Revox::Models::AssistantCreateResponse::Assistant::Slack::Outcome>] Which call outcomes trigger a Slack notification (e.g. ['interested', 'none']).
|
|
1177
|
+
#
|
|
1178
|
+
# @param channel_name [String, nil] Human-readable Slack channel name, cached for display in the UI.
|
|
1179
|
+
#
|
|
1180
|
+
# @param template [String, nil] Optional message template. Supports {{summary}}, {{outcome}}, {{phone}},
|
|
1181
|
+
# {{call\_
|
|
1182
|
+
|
|
1183
|
+
module Outcome
|
|
1184
|
+
extend Revox::Internal::Type::Enum
|
|
1185
|
+
|
|
1186
|
+
NOT_INTERESTED = :not_interested
|
|
1187
|
+
INTERESTED = :interested
|
|
1188
|
+
COMPLETED = :completed
|
|
1189
|
+
REQUESTED_CALLBACK_LATER = :requested_callback_later
|
|
1190
|
+
REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
|
|
1191
|
+
DO_NOT_CONTACT = :do_not_contact
|
|
1192
|
+
AI_AVERSE = :ai_averse
|
|
1193
|
+
NONE = :none
|
|
1194
|
+
|
|
1195
|
+
# @!method self.values
|
|
1196
|
+
# @return [Array<Symbol>]
|
|
1197
|
+
end
|
|
391
1198
|
end
|
|
392
1199
|
|
|
393
1200
|
class StructuredOutputConfig < Revox::Internal::Type::BaseModel
|
|
@@ -440,6 +1247,88 @@ module Revox
|
|
|
440
1247
|
end
|
|
441
1248
|
end
|
|
442
1249
|
|
|
1250
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant#stt_context
|
|
1251
|
+
class SttContext < Revox::Internal::Type::BaseModel
|
|
1252
|
+
# @!attribute general
|
|
1253
|
+
#
|
|
1254
|
+
# @return [Array<Revox::Models::AssistantCreateResponse::Assistant::SttContext::General>]
|
|
1255
|
+
required :general,
|
|
1256
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantCreateResponse::Assistant::SttContext::General] }
|
|
1257
|
+
|
|
1258
|
+
# @!attribute terms
|
|
1259
|
+
#
|
|
1260
|
+
# @return [Array<String>]
|
|
1261
|
+
required :terms, Revox::Internal::Type::ArrayOf[String]
|
|
1262
|
+
|
|
1263
|
+
# @!method initialize(general:, terms:)
|
|
1264
|
+
# Assistant-level speech-to-text context: structured `general` key/value pairs
|
|
1265
|
+
# plus a list of domain `terms`. Prompt-derived context is merged in without
|
|
1266
|
+
# replacing existing entries.
|
|
1267
|
+
#
|
|
1268
|
+
# @param general [Array<Revox::Models::AssistantCreateResponse::Assistant::SttContext::General>]
|
|
1269
|
+
# @param terms [Array<String>]
|
|
1270
|
+
|
|
1271
|
+
class General < Revox::Internal::Type::BaseModel
|
|
1272
|
+
# @!attribute key
|
|
1273
|
+
#
|
|
1274
|
+
# @return [String]
|
|
1275
|
+
required :key, String
|
|
1276
|
+
|
|
1277
|
+
# @!attribute value
|
|
1278
|
+
#
|
|
1279
|
+
# @return [String]
|
|
1280
|
+
required :value, String
|
|
1281
|
+
|
|
1282
|
+
# @!method initialize(key:, value:)
|
|
1283
|
+
# @param key [String]
|
|
1284
|
+
# @param value [String]
|
|
1285
|
+
end
|
|
1286
|
+
end
|
|
1287
|
+
|
|
1288
|
+
# Transcriber (speech-to-text) model used for the assistant.
|
|
1289
|
+
#
|
|
1290
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant#stt_model
|
|
1291
|
+
module SttModel
|
|
1292
|
+
extend Revox::Internal::Type::Enum
|
|
1293
|
+
|
|
1294
|
+
STT_RT_V4 = :"stt-rt-v4"
|
|
1295
|
+
STT_RT_V5 = :"stt-rt-v5"
|
|
1296
|
+
|
|
1297
|
+
# @!method self.values
|
|
1298
|
+
# @return [Array<Symbol>]
|
|
1299
|
+
end
|
|
1300
|
+
|
|
1301
|
+
# Audio clip to play while the agent is processing a response. One of the built-in
|
|
1302
|
+
# LiveKit audio clips; null disables it.
|
|
1303
|
+
#
|
|
1304
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant#thinking_sound
|
|
1305
|
+
module ThinkingSound
|
|
1306
|
+
extend Revox::Internal::Type::Enum
|
|
1307
|
+
|
|
1308
|
+
CITY_AMBIENCE_OGG = :"city-ambience.ogg"
|
|
1309
|
+
FOREST_AMBIENCE_OGG = :"forest-ambience.ogg"
|
|
1310
|
+
OFFICE_AMBIENCE_OGG = :"office-ambience.ogg"
|
|
1311
|
+
CROWDED_ROOM_OGG = :"crowded-room.ogg"
|
|
1312
|
+
KEYBOARD_TYPING_OGG = :"keyboard-typing.ogg"
|
|
1313
|
+
KEYBOARD_TYPING2_OGG = :"keyboard-typing2.ogg"
|
|
1314
|
+
HOLD_MUSIC_OGG = :"hold_music.ogg"
|
|
1315
|
+
|
|
1316
|
+
# @!method self.values
|
|
1317
|
+
# @return [Array<Symbol>]
|
|
1318
|
+
end
|
|
1319
|
+
|
|
1320
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant#type
|
|
1321
|
+
module Type
|
|
1322
|
+
extend Revox::Internal::Type::Enum
|
|
1323
|
+
|
|
1324
|
+
STANDALONE = :standalone
|
|
1325
|
+
MULTI_STEP = :"multi-step"
|
|
1326
|
+
SUB_ASSISTANT = :"sub-assistant"
|
|
1327
|
+
|
|
1328
|
+
# @!method self.values
|
|
1329
|
+
# @return [Array<Symbol>]
|
|
1330
|
+
end
|
|
1331
|
+
|
|
443
1332
|
# @see Revox::Models::AssistantCreateResponse::Assistant#voice
|
|
444
1333
|
class Voice < Revox::Internal::Type::BaseModel
|
|
445
1334
|
# @!attribute id
|
|
@@ -454,6 +1343,13 @@ module Revox
|
|
|
454
1343
|
# @return [Symbol, Revox::Models::AssistantCreateResponse::Assistant::Voice::Provider]
|
|
455
1344
|
required :provider, enum: -> { Revox::Models::AssistantCreateResponse::Assistant::Voice::Provider }
|
|
456
1345
|
|
|
1346
|
+
# @!attribute model
|
|
1347
|
+
# Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored
|
|
1348
|
+
# for other providers.
|
|
1349
|
+
#
|
|
1350
|
+
# @return [Symbol, Revox::Models::AssistantCreateResponse::Assistant::Voice::Model, nil]
|
|
1351
|
+
optional :model, enum: -> { Revox::Models::AssistantCreateResponse::Assistant::Voice::Model }
|
|
1352
|
+
|
|
457
1353
|
# @!attribute speed
|
|
458
1354
|
# The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs
|
|
459
1355
|
# 0.7–1.2. Default is 1.0.
|
|
@@ -461,7 +1357,14 @@ module Revox
|
|
|
461
1357
|
# @return [Float, nil]
|
|
462
1358
|
optional :speed, Float
|
|
463
1359
|
|
|
464
|
-
# @!
|
|
1360
|
+
# @!attribute volume
|
|
1361
|
+
# Volume of the voice (Cartesia only). 0.5–2.0, default 1.0. Ignored for other
|
|
1362
|
+
# providers.
|
|
1363
|
+
#
|
|
1364
|
+
# @return [Float, nil]
|
|
1365
|
+
optional :volume, Float
|
|
1366
|
+
|
|
1367
|
+
# @!method initialize(id:, provider:, model: nil, speed: nil, volume: nil)
|
|
465
1368
|
# Some parameter documentations has been truncated, see
|
|
466
1369
|
# {Revox::Models::AssistantCreateResponse::Assistant::Voice} for more details.
|
|
467
1370
|
#
|
|
@@ -469,7 +1372,11 @@ module Revox
|
|
|
469
1372
|
#
|
|
470
1373
|
# @param provider [Symbol, Revox::Models::AssistantCreateResponse::Assistant::Voice::Provider] The provider of the voice.
|
|
471
1374
|
#
|
|
1375
|
+
# @param model [Symbol, Revox::Models::AssistantCreateResponse::Assistant::Voice::Model] Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored fo
|
|
1376
|
+
#
|
|
472
1377
|
# @param speed [Float] The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs
|
|
1378
|
+
#
|
|
1379
|
+
# @param volume [Float] Volume of the voice (Cartesia only). 0.5–2.0, default 1.0. Ignored for other pro
|
|
473
1380
|
|
|
474
1381
|
# The provider of the voice.
|
|
475
1382
|
#
|
|
@@ -483,6 +1390,159 @@ module Revox
|
|
|
483
1390
|
# @!method self.values
|
|
484
1391
|
# @return [Array<Symbol>]
|
|
485
1392
|
end
|
|
1393
|
+
|
|
1394
|
+
# Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored
|
|
1395
|
+
# for other providers.
|
|
1396
|
+
#
|
|
1397
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant::Voice#model
|
|
1398
|
+
module Model
|
|
1399
|
+
extend Revox::Internal::Type::Enum
|
|
1400
|
+
|
|
1401
|
+
SONIC_3 = :"sonic-3"
|
|
1402
|
+
SONIC_3_5 = :"sonic-3.5"
|
|
1403
|
+
|
|
1404
|
+
# @!method self.values
|
|
1405
|
+
# @return [Array<Symbol>]
|
|
1406
|
+
end
|
|
1407
|
+
end
|
|
1408
|
+
|
|
1409
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant#zoho
|
|
1410
|
+
class Zoho < Revox::Internal::Type::BaseModel
|
|
1411
|
+
# @!attribute connection_id
|
|
1412
|
+
# The Nango connection ID linking the org's Zoho CRM account to Revox.
|
|
1413
|
+
#
|
|
1414
|
+
# @return [String]
|
|
1415
|
+
required :connection_id, String
|
|
1416
|
+
|
|
1417
|
+
# @!attribute field_mapping
|
|
1418
|
+
# Maps extracted call fields (structured_output / prompt variables) onto Zoho
|
|
1419
|
+
# field API names on the upserted record.
|
|
1420
|
+
#
|
|
1421
|
+
# @return [Array<Revox::Models::AssistantCreateResponse::Assistant::Zoho::FieldMapping>]
|
|
1422
|
+
required :field_mapping,
|
|
1423
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantCreateResponse::Assistant::Zoho::FieldMapping] }
|
|
1424
|
+
|
|
1425
|
+
# @!attribute log_call_activity
|
|
1426
|
+
# When true, also log the call as a record in Zoho's Calls module (related to the
|
|
1427
|
+
# upserted prospect via Who_Id).
|
|
1428
|
+
#
|
|
1429
|
+
# @return [Boolean]
|
|
1430
|
+
required :log_call_activity, Revox::Internal::Type::Boolean
|
|
1431
|
+
|
|
1432
|
+
# @!attribute module_
|
|
1433
|
+
# Zoho module the prospect record is upserted into (e.g. 'Leads' or 'Contacts').
|
|
1434
|
+
#
|
|
1435
|
+
# @return [String]
|
|
1436
|
+
required :module_, String, api_name: :module
|
|
1437
|
+
|
|
1438
|
+
# @!attribute outcomes
|
|
1439
|
+
# Which call outcomes trigger the Zoho push (e.g. ['interested', 'none']). Use
|
|
1440
|
+
# 'none' to push when outcome is null.
|
|
1441
|
+
#
|
|
1442
|
+
# @return [Array<Symbol, Revox::Models::AssistantCreateResponse::Assistant::Zoho::Outcome>]
|
|
1443
|
+
required :outcomes,
|
|
1444
|
+
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::AssistantCreateResponse::Assistant::Zoho::Outcome] }
|
|
1445
|
+
|
|
1446
|
+
# @!attribute template
|
|
1447
|
+
# Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}},
|
|
1448
|
+
# {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{transcript}}, plus
|
|
1449
|
+
# prompt_variables and structured_output keys. When null/empty a default note
|
|
1450
|
+
# (outcome + summary + auto-listed extracted fields) is used.
|
|
1451
|
+
#
|
|
1452
|
+
# @return [String, nil]
|
|
1453
|
+
optional :template, String, nil?: true
|
|
1454
|
+
|
|
1455
|
+
# @!method initialize(connection_id:, field_mapping:, log_call_activity:, module_:, outcomes:, template: nil)
|
|
1456
|
+
# Some parameter documentations has been truncated, see
|
|
1457
|
+
# {Revox::Models::AssistantCreateResponse::Assistant::Zoho} for more details.
|
|
1458
|
+
#
|
|
1459
|
+
# @param connection_id [String] The Nango connection ID linking the org's Zoho CRM account to Revox.
|
|
1460
|
+
#
|
|
1461
|
+
# @param field_mapping [Array<Revox::Models::AssistantCreateResponse::Assistant::Zoho::FieldMapping>] Maps extracted call fields (structured_output / prompt variables) onto Zoho fiel
|
|
1462
|
+
#
|
|
1463
|
+
# @param log_call_activity [Boolean] When true, also log the call as a record in Zoho's Calls module (related to the
|
|
1464
|
+
#
|
|
1465
|
+
# @param module_ [String] Zoho module the prospect record is upserted into (e.g. 'Leads' or 'Contacts').
|
|
1466
|
+
#
|
|
1467
|
+
# @param outcomes [Array<Symbol, Revox::Models::AssistantCreateResponse::Assistant::Zoho::Outcome>] Which call outcomes trigger the Zoho push (e.g. ['interested', 'none']). Use 'no
|
|
1468
|
+
#
|
|
1469
|
+
# @param template [String, nil] Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}}, {{cal
|
|
1470
|
+
|
|
1471
|
+
class FieldMapping < Revox::Internal::Type::BaseModel
|
|
1472
|
+
# @!attribute source
|
|
1473
|
+
# Source key to read from the call: a structured_output field name, falling back
|
|
1474
|
+
# to a prompt variable of the same name.
|
|
1475
|
+
#
|
|
1476
|
+
# @return [String]
|
|
1477
|
+
required :source, String
|
|
1478
|
+
|
|
1479
|
+
# @!attribute zoho_field
|
|
1480
|
+
# Destination Zoho field API name on the upserted record (e.g. 'Email', 'Company',
|
|
1481
|
+
# or a custom 'Budget\_\_c').
|
|
1482
|
+
#
|
|
1483
|
+
# @return [String]
|
|
1484
|
+
required :zoho_field, String
|
|
1485
|
+
|
|
1486
|
+
# @!method initialize(source:, zoho_field:)
|
|
1487
|
+
# Some parameter documentations has been truncated, see
|
|
1488
|
+
# {Revox::Models::AssistantCreateResponse::Assistant::Zoho::FieldMapping} for more
|
|
1489
|
+
# details.
|
|
1490
|
+
#
|
|
1491
|
+
# @param source [String] Source key to read from the call: a structured_output field name, falling back t
|
|
1492
|
+
#
|
|
1493
|
+
# @param zoho_field [String] Destination Zoho field API name on the upserted record (e.g. 'Email', 'Company',
|
|
1494
|
+
end
|
|
1495
|
+
|
|
1496
|
+
module Outcome
|
|
1497
|
+
extend Revox::Internal::Type::Enum
|
|
1498
|
+
|
|
1499
|
+
NOT_INTERESTED = :not_interested
|
|
1500
|
+
INTERESTED = :interested
|
|
1501
|
+
COMPLETED = :completed
|
|
1502
|
+
REQUESTED_CALLBACK_LATER = :requested_callback_later
|
|
1503
|
+
REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
|
|
1504
|
+
DO_NOT_CONTACT = :do_not_contact
|
|
1505
|
+
AI_AVERSE = :ai_averse
|
|
1506
|
+
NONE = :none
|
|
1507
|
+
|
|
1508
|
+
# @!method self.values
|
|
1509
|
+
# @return [Array<Symbol>]
|
|
1510
|
+
end
|
|
1511
|
+
end
|
|
1512
|
+
|
|
1513
|
+
# @see Revox::Models::AssistantCreateResponse::Assistant#created_by
|
|
1514
|
+
class CreatedBy < Revox::Internal::Type::BaseModel
|
|
1515
|
+
# @!attribute id
|
|
1516
|
+
# The database user id of the creator.
|
|
1517
|
+
#
|
|
1518
|
+
# @return [String]
|
|
1519
|
+
required :id, String
|
|
1520
|
+
|
|
1521
|
+
# @!attribute email
|
|
1522
|
+
#
|
|
1523
|
+
# @return [String]
|
|
1524
|
+
required :email, String
|
|
1525
|
+
|
|
1526
|
+
# @!attribute first_name
|
|
1527
|
+
#
|
|
1528
|
+
# @return [String, nil]
|
|
1529
|
+
required :first_name, String, nil?: true
|
|
1530
|
+
|
|
1531
|
+
# @!attribute last_name
|
|
1532
|
+
#
|
|
1533
|
+
# @return [String, nil]
|
|
1534
|
+
required :last_name, String, nil?: true
|
|
1535
|
+
|
|
1536
|
+
# @!method initialize(id:, email:, first_name:, last_name:)
|
|
1537
|
+
# The user who created the assistant.
|
|
1538
|
+
#
|
|
1539
|
+
# @param id [String] The database user id of the creator.
|
|
1540
|
+
#
|
|
1541
|
+
# @param email [String]
|
|
1542
|
+
#
|
|
1543
|
+
# @param first_name [String, nil]
|
|
1544
|
+
#
|
|
1545
|
+
# @param last_name [String, nil]
|
|
486
1546
|
end
|
|
487
1547
|
|
|
488
1548
|
class FaqItem < Revox::Internal::Type::BaseModel
|