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.
Files changed (89) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +71 -0
  3. data/README.md +39 -14
  4. data/lib/revox/client.rb +15 -1
  5. data/lib/revox/internal/transport/base_client.rb +5 -0
  6. data/lib/revox/internal/util.rb +22 -7
  7. data/lib/revox/models/assistant_create_params.rb +1038 -13
  8. data/lib/revox/models/assistant_create_response.rb +1071 -11
  9. data/lib/revox/models/assistant_list_response.rb +1070 -11
  10. data/lib/revox/models/assistant_retrieve_response.rb +1066 -11
  11. data/lib/revox/models/assistant_update_params.rb +1038 -13
  12. data/lib/revox/models/assistant_update_response.rb +1097 -12
  13. data/lib/revox/models/call_create_params.rb +1065 -13
  14. data/lib/revox/models/call_create_response.rb +1813 -101
  15. data/lib/revox/models/call_retrieve_response.rb +1815 -101
  16. data/lib/revox/models/campaign_create_params.rb +67 -2
  17. data/lib/revox/models/campaign_create_response.rb +1314 -59
  18. data/lib/revox/models/campaign_get_rows_params.rb +1 -46
  19. data/lib/revox/models/campaign_get_rows_response.rb +1837 -129
  20. data/lib/revox/models/campaign_list_response.rb +1312 -59
  21. data/lib/revox/models/campaign_retrieve_response.rb +1312 -56
  22. data/lib/revox/models/users/me_retrieve_response.rb +13 -1
  23. data/lib/revox/models/users/me_update_response.rb +13 -1
  24. data/lib/revox/models/voice_list_response.rb +55 -1
  25. data/lib/revox/models/voice_preview_params.rb +49 -1
  26. data/lib/revox/models.rb +0 -2
  27. data/lib/revox/resources/assistants.rb +116 -8
  28. data/lib/revox/resources/call.rb +0 -29
  29. data/lib/revox/resources/campaigns.rb +12 -17
  30. data/lib/revox/resources/voices.rb +16 -10
  31. data/lib/revox/version.rb +1 -1
  32. data/lib/revox.rb +0 -2
  33. data/rbi/revox/internal/util.rbi +8 -0
  34. data/rbi/revox/models/assistant_create_params.rbi +2138 -103
  35. data/rbi/revox/models/assistant_create_response.rbi +2454 -199
  36. data/rbi/revox/models/assistant_list_response.rbi +2448 -195
  37. data/rbi/revox/models/assistant_retrieve_response.rbi +2401 -210
  38. data/rbi/revox/models/assistant_update_params.rbi +2138 -103
  39. data/rbi/revox/models/assistant_update_response.rbi +2504 -198
  40. data/rbi/revox/models/call_create_params.rbi +2382 -225
  41. data/rbi/revox/models/call_create_response.rbi +4104 -384
  42. data/rbi/revox/models/call_retrieve_response.rbi +4104 -382
  43. data/rbi/revox/models/campaign_create_params.rbi +136 -0
  44. data/rbi/revox/models/campaign_create_response.rbi +2911 -231
  45. data/rbi/revox/models/campaign_get_rows_params.rbi +2 -82
  46. data/rbi/revox/models/campaign_get_rows_response.rbi +4135 -410
  47. data/rbi/revox/models/campaign_list_response.rbi +2904 -230
  48. data/rbi/revox/models/campaign_retrieve_response.rbi +2911 -231
  49. data/rbi/revox/models/users/me_retrieve_response.rbi +13 -3
  50. data/rbi/revox/models/users/me_update_response.rbi +13 -3
  51. data/rbi/revox/models/voice_list_response.rbi +105 -3
  52. data/rbi/revox/models/voice_preview_params.rbi +69 -0
  53. data/rbi/revox/models.rbi +0 -2
  54. data/rbi/revox/resources/assistants.rbi +284 -8
  55. data/rbi/revox/resources/call.rbi +0 -21
  56. data/rbi/revox/resources/campaigns.rbi +12 -19
  57. data/rbi/revox/resources/voices.rbi +17 -9
  58. data/sig/revox/internal/util.rbs +4 -0
  59. data/sig/revox/models/assistant_create_params.rbs +844 -11
  60. data/sig/revox/models/assistant_create_response.rbs +860 -3
  61. data/sig/revox/models/assistant_list_response.rbs +860 -3
  62. data/sig/revox/models/assistant_retrieve_response.rbs +859 -3
  63. data/sig/revox/models/assistant_update_params.rbs +844 -11
  64. data/sig/revox/models/assistant_update_response.rbs +886 -6
  65. data/sig/revox/models/call_create_params.rbs +847 -13
  66. data/sig/revox/models/call_create_response.rbs +1514 -34
  67. data/sig/revox/models/call_retrieve_response.rbs +1514 -34
  68. data/sig/revox/models/campaign_create_params.rbs +54 -0
  69. data/sig/revox/models/campaign_create_response.rbs +1034 -6
  70. data/sig/revox/models/campaign_get_rows_params.rbs +2 -64
  71. data/sig/revox/models/campaign_get_rows_response.rbs +1522 -54
  72. data/sig/revox/models/campaign_list_response.rbs +1034 -6
  73. data/sig/revox/models/campaign_retrieve_response.rbs +1034 -6
  74. data/sig/revox/models/users/me_retrieve_response.rbs +8 -3
  75. data/sig/revox/models/users/me_update_response.rbs +8 -3
  76. data/sig/revox/models/voice_list_response.rbs +45 -3
  77. data/sig/revox/models/voice_preview_params.rbs +42 -1
  78. data/sig/revox/models.rbs +0 -2
  79. data/sig/revox/resources/assistants.rbs +56 -2
  80. data/sig/revox/resources/call.rbs +0 -7
  81. data/sig/revox/resources/campaigns.rbs +2 -5
  82. data/sig/revox/resources/voices.rbs +4 -0
  83. metadata +2 -8
  84. data/lib/revox/models/call_list_params.rb +0 -52
  85. data/lib/revox/models/call_list_response.rb +0 -259
  86. data/rbi/revox/models/call_list_params.rbi +0 -94
  87. data/rbi/revox/models/call_list_response.rbi +0 -563
  88. data/sig/revox/models/call_list_params.rbs +0 -63
  89. 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::AssistantListResponse::Assistant::AfterCallSMSOutcome>, nil]
27
+ required :after_call_sms_outcomes,
28
+ -> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::AssistantListResponse::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
- # The background sound to play during the call. Useful to give the impression that
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::AssistantListResponse::Assistant::BackgroundSound, nil]
27
42
  required :background_sound,
28
43
  enum: -> { Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::Calendly, nil]
@@ -42,11 +63,48 @@ module Revox
42
63
  -> { Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::CustomTool>, nil]
80
+ required :custom_tools,
81
+ -> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::EmailNotificationLanguage]
96
+ required :email_notification_language,
97
+ enum: -> { Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::EmailNotificationOutcome>, nil]
104
+ required :email_notification_outcomes,
105
+ -> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::AssistantListResponse::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::AssistantListResponse::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::AssistantListResponse::Assistant::HumanTransferMode, nil]
142
+ required :human_transfer_mode,
143
+ enum: -> { Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::LlmModel::UnionMember0, Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember1]
155
+ # @return [Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember0, Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember1, Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember2, Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember3]
82
156
  required :llm_model, union: -> { Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::Position, nil]
193
+ required :position, -> { Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::PromptFlow, nil]
203
+ required :prompt_flow, -> { Revox::Models::AssistantListResponse::Assistant::PromptFlow }, nil?: true
204
+
205
+ # @!attribute slack
206
+ #
207
+ # @return [Revox::Models::AssistantListResponse::Assistant::Slack, nil]
208
+ required :slack, -> { Revox::Models::AssistantListResponse::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::AssistantListResponse::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::AssistantListResponse::Assistant::SttContext, nil]
248
+ required :stt_context, -> { Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::SttModel]
254
+ required :stt_model, enum: -> { Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::ThinkingSound, nil]
261
+ required :thinking_sound,
262
+ enum: -> { Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::Type]
287
+ required :type, enum: -> { Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::Zoho, nil]
329
+ required :zoho, -> { Revox::Models::AssistantListResponse::Assistant::Zoho }, nil?: true
330
+
331
+ # @!attribute created_by
332
+ # The user who created the assistant.
333
+ #
334
+ # @return [Revox::Models::AssistantListResponse::Assistant::CreatedBy, nil]
335
+ optional :created_by, -> { Revox::Models::AssistantListResponse::Assistant::CreatedBy }, nil?: true
336
+
144
337
  # @!attribute faq_items
145
338
  #
146
339
  # @return [Array<Revox::Models::AssistantListResponse::Assistant::FaqItem>, nil]
147
340
  optional :faq_items,
148
341
  -> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant} for more details.
158
356
  #
159
357
  # @param id [String]
160
358
  #
161
- # @param background_sound [Symbol, Revox::Models::AssistantListResponse::Assistant::BackgroundSound, nil] The background sound to play during the call. Useful to give the impression that
359
+ # @param after_call_sms_outcomes [Array<Symbol, Revox::Models::AssistantListResponse::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::AssistantListResponse::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::AssistantListResponse::Assistant::Calendly, nil]
164
368
  #
165
369
  # @param call_retry_config [Revox::Models::AssistantListResponse::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::AssistantListResponse::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::AssistantListResponse::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::AssistantListResponse::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::AssistantListResponse::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::AssistantListResponse::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::AssistantListResponse::Assistant::LlmModel::UnionMember0, Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember1]
397
+ # @param llm_model [Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember0, Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember1, Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember2, Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::Position, nil]
410
+ #
187
411
  # @param prompt [String]
188
412
  #
413
+ # @param prompt_flow [Revox::Models::AssistantListResponse::Assistant::PromptFlow, nil]
414
+ #
415
+ # @param slack [Revox::Models::AssistantListResponse::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::AssistantListResponse::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::AssistantListResponse::Assistant::SttContext, nil] Assistant-level speech-to-text context: structured `general` key/value pairs plu
426
+ #
427
+ # @param stt_model [Symbol, Revox::Models::AssistantListResponse::Assistant::SttModel] Transcriber (speech-to-text) model used for the assistant.
428
+ #
429
+ # @param thinking_sound [Symbol, Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::Type]
438
+ #
193
439
  # @param updated_at [Object]
194
440
  #
195
441
  # @param voice [Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::Zoho, nil]
452
+ #
453
+ # @param created_by [Revox::Models::AssistantListResponse::Assistant::CreatedBy, nil] The user who created the assistant.
454
+ #
201
455
  # @param faq_items [Array<Revox::Models::AssistantListResponse::Assistant::FaqItem>]
202
456
  #
457
+ # @param is_realestate_assistant [Boolean]
458
+ #
203
459
  # @param pending_faq_count [Float]
204
460
 
205
- # The background sound to play during the call. Useful to give the impression that
206
- # your AI agent is in an office.
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::AssistantListResponse::Assistant#background_sound
209
480
  module BackgroundSound
@@ -241,6 +512,23 @@ module Revox
241
512
 
242
513
  # @see Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::CallRetryConfig::AllowedDay>]
520
+ required :allowed_days,
521
+ -> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::AssistantListResponse::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::AssistantListResponse::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::AssistantListResponse::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::AssistantListResponse::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::AssistantListResponse::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,213 @@ 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::AssistantListResponse::Assistant::CustomTool::Header>]
640
+ required :headers,
641
+ -> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::CustomTool::InputSchema>]
648
+ required :input_schema,
649
+ -> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantListResponse::Assistant::CustomTool::InputSchema] }
650
+
651
+ # @!attribute method_
652
+ # HTTP method to use when calling the API endpoint
653
+ #
654
+ # @return [Symbol, Revox::Models::AssistantListResponse::Assistant::CustomTool::Method]
655
+ required :method_,
656
+ enum: -> { Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::CustomTool::QueryParam>]
670
+ required :query_params,
671
+ -> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantListResponse::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::AssistantListResponse::Assistant::CustomTool} for more details.
683
+ #
684
+ # @param body_template [String, nil] JSON body template for the request. Use quoted {{variable}} placeholders (e.g. "
685
+ #
686
+ # @param description [String] Human-readable description of what the tool does, used by the LLM to decide when
687
+ #
688
+ # @param headers [Array<Revox::Models::AssistantListResponse::Assistant::CustomTool::Header>] HTTP headers to include in the request. Values support {{variable}} placeholders
689
+ #
690
+ # @param input_schema [Array<Revox::Models::AssistantListResponse::Assistant::CustomTool::InputSchema>] Schema defining the parameters the LLM should extract from the conversation to p
691
+ #
692
+ # @param method_ [Symbol, Revox::Models::AssistantListResponse::Assistant::CustomTool::Method] HTTP method to use when calling the API endpoint
693
+ #
694
+ # @param name [String] Unique tool name in lowercase_snake_case (e.g. check_inventory)
695
+ #
696
+ # @param query_params [Array<Revox::Models::AssistantListResponse::Assistant::CustomTool::QueryParam>] Query string parameters appended to the URL. Values support {{variable}} placeho
697
+ #
698
+ # @param url [String] Full URL of the API endpoint. Supports {{variable}} placeholders for dynamic val
699
+
700
+ class Header < Revox::Internal::Type::BaseModel
701
+ # @!attribute key
702
+ #
703
+ # @return [String]
704
+ required :key, String
705
+
706
+ # @!attribute value
707
+ #
708
+ # @return [String]
709
+ required :value, String
710
+
711
+ # @!method initialize(key:, value:)
712
+ # @param key [String]
713
+ # @param value [String]
714
+ end
715
+
716
+ class InputSchema < Revox::Internal::Type::BaseModel
717
+ # @!attribute name
718
+ #
719
+ # @return [String]
720
+ required :name, String
721
+
722
+ # @!attribute required
723
+ #
724
+ # @return [Boolean]
725
+ required :required, Revox::Internal::Type::Boolean
726
+
727
+ # @!attribute type
728
+ #
729
+ # @return [Symbol, Revox::Models::AssistantListResponse::Assistant::CustomTool::InputSchema::Type]
730
+ required :type,
731
+ enum: -> { Revox::Models::AssistantListResponse::Assistant::CustomTool::InputSchema::Type }
732
+
733
+ # @!attribute description
734
+ #
735
+ # @return [String, nil]
736
+ optional :description, String
737
+
738
+ # @!attribute enum_options
739
+ #
740
+ # @return [Array<String>, nil]
741
+ optional :enum_options, Revox::Internal::Type::ArrayOf[String]
742
+
743
+ # @!method initialize(name:, required:, type:, description: nil, enum_options: nil)
744
+ # @param name [String]
745
+ # @param required [Boolean]
746
+ # @param type [Symbol, Revox::Models::AssistantListResponse::Assistant::CustomTool::InputSchema::Type]
747
+ # @param description [String]
748
+ # @param enum_options [Array<String>]
749
+
750
+ # @see Revox::Models::AssistantListResponse::Assistant::CustomTool::InputSchema#type
751
+ module Type
752
+ extend Revox::Internal::Type::Enum
753
+
754
+ STRING = :string
755
+ NUMBER = :number
756
+ BOOLEAN = :boolean
757
+ ENUM = :enum
758
+ DATE = :date
759
+ DATETIME = :datetime
760
+
761
+ # @!method self.values
762
+ # @return [Array<Symbol>]
763
+ end
764
+ end
765
+
766
+ # HTTP method to use when calling the API endpoint
767
+ #
768
+ # @see Revox::Models::AssistantListResponse::Assistant::CustomTool#method_
769
+ module Method
770
+ extend Revox::Internal::Type::Enum
771
+
772
+ GET = :GET
773
+ POST = :POST
774
+ PUT = :PUT
775
+ PATCH = :PATCH
776
+ DELETE = :DELETE
777
+
778
+ # @!method self.values
779
+ # @return [Array<Symbol>]
780
+ end
781
+
782
+ class QueryParam < Revox::Internal::Type::BaseModel
783
+ # @!attribute key
784
+ #
785
+ # @return [String]
786
+ required :key, String
787
+
788
+ # @!attribute value
789
+ #
790
+ # @return [String]
791
+ required :value, String
792
+
793
+ # @!method initialize(key:, value:)
794
+ # @param key [String]
795
+ # @param value [String]
796
+ end
797
+ end
798
+
799
+ # The language used for the notification email content. One of "en" or "fr".
800
+ #
801
+ # @see Revox::Models::AssistantListResponse::Assistant#email_notification_language
802
+ module EmailNotificationLanguage
803
+ extend Revox::Internal::Type::Enum
804
+
805
+ EN = :en
806
+ FR = :fr
807
+
808
+ # @!method self.values
809
+ # @return [Array<Symbol>]
810
+ end
811
+
812
+ module EmailNotificationOutcome
813
+ extend Revox::Internal::Type::Enum
814
+
815
+ NOT_INTERESTED = :not_interested
816
+ INTERESTED = :interested
817
+ COMPLETED = :completed
818
+ REQUESTED_CALLBACK_LATER = :requested_callback_later
819
+ REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
820
+ DO_NOT_CONTACT = :do_not_contact
821
+ AI_AVERSE = :ai_averse
822
+ NONE = :none
823
+
824
+ # @!method self.values
825
+ # @return [Array<Symbol>]
826
+ end
827
+
314
828
  # @see Revox::Models::AssistantListResponse::Assistant#first_sentence_mode
315
829
  module FirstSentenceMode
316
830
  extend Revox::Internal::Type::Enum
@@ -323,6 +837,20 @@ module Revox
323
837
  # @return [Array<Symbol>]
324
838
  end
325
839
 
840
+ # Warm or cold transfer when transfer_phone_number is set; null when transfer is
841
+ # not configured.
842
+ #
843
+ # @see Revox::Models::AssistantListResponse::Assistant#human_transfer_mode
844
+ module HumanTransferMode
845
+ extend Revox::Internal::Type::Enum
846
+
847
+ WARM = :warm
848
+ COLD = :cold
849
+
850
+ # @!method self.values
851
+ # @return [Array<Symbol>]
852
+ end
853
+
326
854
  # @see Revox::Models::AssistantListResponse::Assistant#llm_model
327
855
  module LlmModel
328
856
  extend Revox::Internal::Type::Union
@@ -331,6 +859,10 @@ module Revox
331
859
 
332
860
  variant -> { Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember1 }
333
861
 
862
+ variant -> { Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember2 }
863
+
864
+ variant -> { Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember3 }
865
+
334
866
  class UnionMember0 < Revox::Internal::Type::BaseModel
335
867
  # @!attribute name
336
868
  #
@@ -385,8 +917,282 @@ module Revox
385
917
  # @param type [Symbol, :openrouter] Use a model from OpenRouter.
386
918
  end
387
919
 
920
+ class UnionMember2 < Revox::Internal::Type::BaseModel
921
+ # @!attribute api_key
922
+ # API key sent as Bearer token to the custom endpoint.
923
+ #
924
+ # @return [String]
925
+ required :api_key, String
926
+
927
+ # @!attribute api_url
928
+ # Base URL for the OpenAI-compatible API, e.g. https://api.together.xyz/v1
929
+ #
930
+ # @return [String]
931
+ required :api_url, String
932
+
933
+ # @!attribute model_name
934
+ # Model name as expected by the provider, e.g. meta-llama/llama-3-70b
935
+ #
936
+ # @return [String]
937
+ required :model_name, String
938
+
939
+ # @!attribute type
940
+ # OpenAI-compatible chat completions API (bring your own endpoint and key).
941
+ #
942
+ # @return [Symbol, :custom]
943
+ required :type, const: :custom
944
+
945
+ # @!method initialize(api_key:, api_url:, model_name:, type: :custom)
946
+ # @param api_key [String] API key sent as Bearer token to the custom endpoint.
947
+ #
948
+ # @param api_url [String] Base URL for the OpenAI-compatible API, e.g. https://api.together.xyz/v1
949
+ #
950
+ # @param model_name [String] Model name as expected by the provider, e.g. meta-llama/llama-3-70b
951
+ #
952
+ # @param type [Symbol, :custom] OpenAI-compatible chat completions API (bring your own endpoint and key).
953
+ end
954
+
955
+ class UnionMember3 < Revox::Internal::Type::BaseModel
956
+ # @!attribute provider
957
+ # The provider to use from Realtime. eg: openai, google.
958
+ #
959
+ # @return [Symbol, Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember3::Provider]
960
+ required :provider,
961
+ enum: -> { Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember3::Provider }
962
+
963
+ # @!attribute realtime_model_id
964
+ # The model ID to use from Realtime. eg: gpt-4.1
965
+ #
966
+ # @return [String]
967
+ required :realtime_model_id, String
968
+
969
+ # @!attribute type
970
+ # Use a model from Realtime.
971
+ #
972
+ # @return [Symbol, :realtime]
973
+ required :type, const: :realtime
974
+
975
+ # @!attribute realtime_voice_id
976
+ # Output voice for the realtime provider (e.g. OpenAI: marin; Gemini: Puck).
977
+ #
978
+ # @return [String, nil]
979
+ optional :realtime_voice_id, String
980
+
981
+ # @!method initialize(provider:, realtime_model_id:, realtime_voice_id: nil, type: :realtime)
982
+ # @param provider [Symbol, Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember3::Provider] The provider to use from Realtime. eg: openai, google.
983
+ #
984
+ # @param realtime_model_id [String] The model ID to use from Realtime. eg: gpt-4.1
985
+ #
986
+ # @param realtime_voice_id [String] Output voice for the realtime provider (e.g. OpenAI: marin; Gemini: Puck).
987
+ #
988
+ # @param type [Symbol, :realtime] Use a model from Realtime.
989
+
990
+ # The provider to use from Realtime. eg: openai, google.
991
+ #
992
+ # @see Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember3#provider
993
+ module Provider
994
+ extend Revox::Internal::Type::Enum
995
+
996
+ OPENAI = :openai
997
+ GOOGLE = :google
998
+
999
+ # @!method self.values
1000
+ # @return [Array<Symbol>]
1001
+ end
1002
+ end
1003
+
388
1004
  # @!method self.variants
389
- # @return [Array(Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember0, Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember1)]
1005
+ # @return [Array(Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember0, Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember1, Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember2, Revox::Models::AssistantListResponse::Assistant::LlmModel::UnionMember3)]
1006
+ end
1007
+
1008
+ # @see Revox::Models::AssistantListResponse::Assistant#position
1009
+ class Position < Revox::Internal::Type::BaseModel
1010
+ # @!attribute x
1011
+ #
1012
+ # @return [Float]
1013
+ required :x, Float
1014
+
1015
+ # @!attribute y_
1016
+ #
1017
+ # @return [Float]
1018
+ required :y_, Float, api_name: :y
1019
+
1020
+ # @!method initialize(x:, y_:)
1021
+ # @param x [Float]
1022
+ # @param y_ [Float]
1023
+ end
1024
+
1025
+ # @see Revox::Models::AssistantListResponse::Assistant#prompt_flow
1026
+ class PromptFlow < Revox::Internal::Type::BaseModel
1027
+ # @!attribute edges
1028
+ #
1029
+ # @return [Array<Revox::Models::AssistantListResponse::Assistant::PromptFlow::Edge>]
1030
+ required :edges,
1031
+ -> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantListResponse::Assistant::PromptFlow::Edge] }
1032
+
1033
+ # @!attribute nodes
1034
+ #
1035
+ # @return [Array<Revox::Models::AssistantListResponse::Assistant::PromptFlow::Node>]
1036
+ required :nodes,
1037
+ -> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantListResponse::Assistant::PromptFlow::Node] }
1038
+
1039
+ # @!method initialize(edges:, nodes:)
1040
+ # @param edges [Array<Revox::Models::AssistantListResponse::Assistant::PromptFlow::Edge>]
1041
+ # @param nodes [Array<Revox::Models::AssistantListResponse::Assistant::PromptFlow::Node>]
1042
+
1043
+ class Edge < Revox::Internal::Type::BaseModel
1044
+ # @!attribute id
1045
+ #
1046
+ # @return [String]
1047
+ required :id, String
1048
+
1049
+ # @!attribute source
1050
+ #
1051
+ # @return [String]
1052
+ required :source, String
1053
+
1054
+ # @!attribute target
1055
+ #
1056
+ # @return [String]
1057
+ required :target, String
1058
+
1059
+ # @!method initialize(id:, source:, target:)
1060
+ # @param id [String]
1061
+ # @param source [String]
1062
+ # @param target [String]
1063
+ end
1064
+
1065
+ class Node < Revox::Internal::Type::BaseModel
1066
+ # @!attribute id
1067
+ #
1068
+ # @return [String]
1069
+ required :id, String
1070
+
1071
+ # @!attribute data
1072
+ #
1073
+ # @return [Revox::Models::AssistantListResponse::Assistant::PromptFlow::Node::Data]
1074
+ required :data, -> { Revox::Models::AssistantListResponse::Assistant::PromptFlow::Node::Data }
1075
+
1076
+ # @!attribute position
1077
+ #
1078
+ # @return [Revox::Models::AssistantListResponse::Assistant::PromptFlow::Node::Position]
1079
+ required :position, -> { Revox::Models::AssistantListResponse::Assistant::PromptFlow::Node::Position }
1080
+
1081
+ # @!attribute type
1082
+ #
1083
+ # @return [Symbol, :promptBlock]
1084
+ required :type, const: :promptBlock
1085
+
1086
+ # @!method initialize(id:, data:, position:, type: :promptBlock)
1087
+ # @param id [String]
1088
+ # @param data [Revox::Models::AssistantListResponse::Assistant::PromptFlow::Node::Data]
1089
+ # @param position [Revox::Models::AssistantListResponse::Assistant::PromptFlow::Node::Position]
1090
+ # @param type [Symbol, :promptBlock]
1091
+
1092
+ # @see Revox::Models::AssistantListResponse::Assistant::PromptFlow::Node#data
1093
+ class Data < Revox::Internal::Type::BaseModel
1094
+ # @!attribute body
1095
+ #
1096
+ # @return [String]
1097
+ required :body, String
1098
+
1099
+ # @!attribute title
1100
+ #
1101
+ # @return [String]
1102
+ required :title, String
1103
+
1104
+ # @!method initialize(body:, title:)
1105
+ # @param body [String]
1106
+ # @param title [String]
1107
+ end
1108
+
1109
+ # @see Revox::Models::AssistantListResponse::Assistant::PromptFlow::Node#position
1110
+ class Position < Revox::Internal::Type::BaseModel
1111
+ # @!attribute x
1112
+ #
1113
+ # @return [Float]
1114
+ required :x, Float
1115
+
1116
+ # @!attribute y_
1117
+ #
1118
+ # @return [Float]
1119
+ required :y_, Float, api_name: :y
1120
+
1121
+ # @!method initialize(x:, y_:)
1122
+ # @param x [Float]
1123
+ # @param y_ [Float]
1124
+ end
1125
+ end
1126
+ end
1127
+
1128
+ # @see Revox::Models::AssistantListResponse::Assistant#slack
1129
+ class Slack < Revox::Internal::Type::BaseModel
1130
+ # @!attribute channel_id
1131
+ # The Slack channel ID where the notification will be posted.
1132
+ #
1133
+ # @return [String]
1134
+ required :channel_id, String
1135
+
1136
+ # @!attribute connection_id
1137
+ # The Nango connection ID linking the org's Slack workspace to Revox.
1138
+ #
1139
+ # @return [String]
1140
+ required :connection_id, String
1141
+
1142
+ # @!attribute outcomes
1143
+ # Which call outcomes trigger a Slack notification (e.g. ['interested', 'none']).
1144
+ # Use 'none' to notify when outcome is null.
1145
+ #
1146
+ # @return [Array<Symbol, Revox::Models::AssistantListResponse::Assistant::Slack::Outcome>]
1147
+ required :outcomes,
1148
+ -> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::AssistantListResponse::Assistant::Slack::Outcome] }
1149
+
1150
+ # @!attribute channel_name
1151
+ # Human-readable Slack channel name, cached for display in the UI.
1152
+ #
1153
+ # @return [String, nil]
1154
+ optional :channel_name, String, nil?: true
1155
+
1156
+ # @!attribute template
1157
+ # Optional message template. Supports {{summary}}, {{outcome}}, {{phone}},
1158
+ # {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{first_name}},
1159
+ # {{last_name}}, {{email}}, {{company}}, {{contact_name}}, {{contact_line}}, plus
1160
+ # prompt_variables and structured_output keys. When null/empty a default template
1161
+ # is used.
1162
+ #
1163
+ # @return [String, nil]
1164
+ optional :template, String, nil?: true
1165
+
1166
+ # @!method initialize(channel_id:, connection_id:, outcomes:, channel_name: nil, template: nil)
1167
+ # Some parameter documentations has been truncated, see
1168
+ # {Revox::Models::AssistantListResponse::Assistant::Slack} for more details.
1169
+ #
1170
+ # @param channel_id [String] The Slack channel ID where the notification will be posted.
1171
+ #
1172
+ # @param connection_id [String] The Nango connection ID linking the org's Slack workspace to Revox.
1173
+ #
1174
+ # @param outcomes [Array<Symbol, Revox::Models::AssistantListResponse::Assistant::Slack::Outcome>] Which call outcomes trigger a Slack notification (e.g. ['interested', 'none']).
1175
+ #
1176
+ # @param channel_name [String, nil] Human-readable Slack channel name, cached for display in the UI.
1177
+ #
1178
+ # @param template [String, nil] Optional message template. Supports {{summary}}, {{outcome}}, {{phone}},
1179
+ # {{call\_
1180
+
1181
+ module Outcome
1182
+ extend Revox::Internal::Type::Enum
1183
+
1184
+ NOT_INTERESTED = :not_interested
1185
+ INTERESTED = :interested
1186
+ COMPLETED = :completed
1187
+ REQUESTED_CALLBACK_LATER = :requested_callback_later
1188
+ REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
1189
+ DO_NOT_CONTACT = :do_not_contact
1190
+ AI_AVERSE = :ai_averse
1191
+ NONE = :none
1192
+
1193
+ # @!method self.values
1194
+ # @return [Array<Symbol>]
1195
+ end
390
1196
  end
391
1197
 
392
1198
  class StructuredOutputConfig < Revox::Internal::Type::BaseModel
@@ -438,6 +1244,88 @@ module Revox
438
1244
  end
439
1245
  end
440
1246
 
1247
+ # @see Revox::Models::AssistantListResponse::Assistant#stt_context
1248
+ class SttContext < Revox::Internal::Type::BaseModel
1249
+ # @!attribute general
1250
+ #
1251
+ # @return [Array<Revox::Models::AssistantListResponse::Assistant::SttContext::General>]
1252
+ required :general,
1253
+ -> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantListResponse::Assistant::SttContext::General] }
1254
+
1255
+ # @!attribute terms
1256
+ #
1257
+ # @return [Array<String>]
1258
+ required :terms, Revox::Internal::Type::ArrayOf[String]
1259
+
1260
+ # @!method initialize(general:, terms:)
1261
+ # Assistant-level speech-to-text context: structured `general` key/value pairs
1262
+ # plus a list of domain `terms`. Prompt-derived context is merged in without
1263
+ # replacing existing entries.
1264
+ #
1265
+ # @param general [Array<Revox::Models::AssistantListResponse::Assistant::SttContext::General>]
1266
+ # @param terms [Array<String>]
1267
+
1268
+ class General < Revox::Internal::Type::BaseModel
1269
+ # @!attribute key
1270
+ #
1271
+ # @return [String]
1272
+ required :key, String
1273
+
1274
+ # @!attribute value
1275
+ #
1276
+ # @return [String]
1277
+ required :value, String
1278
+
1279
+ # @!method initialize(key:, value:)
1280
+ # @param key [String]
1281
+ # @param value [String]
1282
+ end
1283
+ end
1284
+
1285
+ # Transcriber (speech-to-text) model used for the assistant.
1286
+ #
1287
+ # @see Revox::Models::AssistantListResponse::Assistant#stt_model
1288
+ module SttModel
1289
+ extend Revox::Internal::Type::Enum
1290
+
1291
+ STT_RT_V4 = :"stt-rt-v4"
1292
+ STT_RT_V5 = :"stt-rt-v5"
1293
+
1294
+ # @!method self.values
1295
+ # @return [Array<Symbol>]
1296
+ end
1297
+
1298
+ # Audio clip to play while the agent is processing a response. One of the built-in
1299
+ # LiveKit audio clips; null disables it.
1300
+ #
1301
+ # @see Revox::Models::AssistantListResponse::Assistant#thinking_sound
1302
+ module ThinkingSound
1303
+ extend Revox::Internal::Type::Enum
1304
+
1305
+ CITY_AMBIENCE_OGG = :"city-ambience.ogg"
1306
+ FOREST_AMBIENCE_OGG = :"forest-ambience.ogg"
1307
+ OFFICE_AMBIENCE_OGG = :"office-ambience.ogg"
1308
+ CROWDED_ROOM_OGG = :"crowded-room.ogg"
1309
+ KEYBOARD_TYPING_OGG = :"keyboard-typing.ogg"
1310
+ KEYBOARD_TYPING2_OGG = :"keyboard-typing2.ogg"
1311
+ HOLD_MUSIC_OGG = :"hold_music.ogg"
1312
+
1313
+ # @!method self.values
1314
+ # @return [Array<Symbol>]
1315
+ end
1316
+
1317
+ # @see Revox::Models::AssistantListResponse::Assistant#type
1318
+ module Type
1319
+ extend Revox::Internal::Type::Enum
1320
+
1321
+ STANDALONE = :standalone
1322
+ MULTI_STEP = :"multi-step"
1323
+ SUB_ASSISTANT = :"sub-assistant"
1324
+
1325
+ # @!method self.values
1326
+ # @return [Array<Symbol>]
1327
+ end
1328
+
441
1329
  # @see Revox::Models::AssistantListResponse::Assistant#voice
442
1330
  class Voice < Revox::Internal::Type::BaseModel
443
1331
  # @!attribute id
@@ -452,6 +1340,13 @@ module Revox
452
1340
  # @return [Symbol, Revox::Models::AssistantListResponse::Assistant::Voice::Provider]
453
1341
  required :provider, enum: -> { Revox::Models::AssistantListResponse::Assistant::Voice::Provider }
454
1342
 
1343
+ # @!attribute model
1344
+ # Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored
1345
+ # for other providers.
1346
+ #
1347
+ # @return [Symbol, Revox::Models::AssistantListResponse::Assistant::Voice::Model, nil]
1348
+ optional :model, enum: -> { Revox::Models::AssistantListResponse::Assistant::Voice::Model }
1349
+
455
1350
  # @!attribute speed
456
1351
  # The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs
457
1352
  # 0.7–1.2. Default is 1.0.
@@ -459,7 +1354,14 @@ module Revox
459
1354
  # @return [Float, nil]
460
1355
  optional :speed, Float
461
1356
 
462
- # @!method initialize(id:, provider:, speed: nil)
1357
+ # @!attribute volume
1358
+ # Volume of the voice (Cartesia only). 0.5–2.0, default 1.0. Ignored for other
1359
+ # providers.
1360
+ #
1361
+ # @return [Float, nil]
1362
+ optional :volume, Float
1363
+
1364
+ # @!method initialize(id:, provider:, model: nil, speed: nil, volume: nil)
463
1365
  # Some parameter documentations has been truncated, see
464
1366
  # {Revox::Models::AssistantListResponse::Assistant::Voice} for more details.
465
1367
  #
@@ -467,7 +1369,11 @@ module Revox
467
1369
  #
468
1370
  # @param provider [Symbol, Revox::Models::AssistantListResponse::Assistant::Voice::Provider] The provider of the voice.
469
1371
  #
1372
+ # @param model [Symbol, Revox::Models::AssistantListResponse::Assistant::Voice::Model] Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored fo
1373
+ #
470
1374
  # @param speed [Float] The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs
1375
+ #
1376
+ # @param volume [Float] Volume of the voice (Cartesia only). 0.5–2.0, default 1.0. Ignored for other pro
471
1377
 
472
1378
  # The provider of the voice.
473
1379
  #
@@ -481,6 +1387,159 @@ module Revox
481
1387
  # @!method self.values
482
1388
  # @return [Array<Symbol>]
483
1389
  end
1390
+
1391
+ # Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored
1392
+ # for other providers.
1393
+ #
1394
+ # @see Revox::Models::AssistantListResponse::Assistant::Voice#model
1395
+ module Model
1396
+ extend Revox::Internal::Type::Enum
1397
+
1398
+ SONIC_3 = :"sonic-3"
1399
+ SONIC_3_5 = :"sonic-3.5"
1400
+
1401
+ # @!method self.values
1402
+ # @return [Array<Symbol>]
1403
+ end
1404
+ end
1405
+
1406
+ # @see Revox::Models::AssistantListResponse::Assistant#zoho
1407
+ class Zoho < Revox::Internal::Type::BaseModel
1408
+ # @!attribute connection_id
1409
+ # The Nango connection ID linking the org's Zoho CRM account to Revox.
1410
+ #
1411
+ # @return [String]
1412
+ required :connection_id, String
1413
+
1414
+ # @!attribute field_mapping
1415
+ # Maps extracted call fields (structured_output / prompt variables) onto Zoho
1416
+ # field API names on the upserted record.
1417
+ #
1418
+ # @return [Array<Revox::Models::AssistantListResponse::Assistant::Zoho::FieldMapping>]
1419
+ required :field_mapping,
1420
+ -> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantListResponse::Assistant::Zoho::FieldMapping] }
1421
+
1422
+ # @!attribute log_call_activity
1423
+ # When true, also log the call as a record in Zoho's Calls module (related to the
1424
+ # upserted prospect via Who_Id).
1425
+ #
1426
+ # @return [Boolean]
1427
+ required :log_call_activity, Revox::Internal::Type::Boolean
1428
+
1429
+ # @!attribute module_
1430
+ # Zoho module the prospect record is upserted into (e.g. 'Leads' or 'Contacts').
1431
+ #
1432
+ # @return [String]
1433
+ required :module_, String, api_name: :module
1434
+
1435
+ # @!attribute outcomes
1436
+ # Which call outcomes trigger the Zoho push (e.g. ['interested', 'none']). Use
1437
+ # 'none' to push when outcome is null.
1438
+ #
1439
+ # @return [Array<Symbol, Revox::Models::AssistantListResponse::Assistant::Zoho::Outcome>]
1440
+ required :outcomes,
1441
+ -> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::AssistantListResponse::Assistant::Zoho::Outcome] }
1442
+
1443
+ # @!attribute template
1444
+ # Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}},
1445
+ # {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{transcript}}, plus
1446
+ # prompt_variables and structured_output keys. When null/empty a default note
1447
+ # (outcome + summary + auto-listed extracted fields) is used.
1448
+ #
1449
+ # @return [String, nil]
1450
+ optional :template, String, nil?: true
1451
+
1452
+ # @!method initialize(connection_id:, field_mapping:, log_call_activity:, module_:, outcomes:, template: nil)
1453
+ # Some parameter documentations has been truncated, see
1454
+ # {Revox::Models::AssistantListResponse::Assistant::Zoho} for more details.
1455
+ #
1456
+ # @param connection_id [String] The Nango connection ID linking the org's Zoho CRM account to Revox.
1457
+ #
1458
+ # @param field_mapping [Array<Revox::Models::AssistantListResponse::Assistant::Zoho::FieldMapping>] Maps extracted call fields (structured_output / prompt variables) onto Zoho fiel
1459
+ #
1460
+ # @param log_call_activity [Boolean] When true, also log the call as a record in Zoho's Calls module (related to the
1461
+ #
1462
+ # @param module_ [String] Zoho module the prospect record is upserted into (e.g. 'Leads' or 'Contacts').
1463
+ #
1464
+ # @param outcomes [Array<Symbol, Revox::Models::AssistantListResponse::Assistant::Zoho::Outcome>] Which call outcomes trigger the Zoho push (e.g. ['interested', 'none']). Use 'no
1465
+ #
1466
+ # @param template [String, nil] Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}}, {{cal
1467
+
1468
+ class FieldMapping < Revox::Internal::Type::BaseModel
1469
+ # @!attribute source
1470
+ # Source key to read from the call: a structured_output field name, falling back
1471
+ # to a prompt variable of the same name.
1472
+ #
1473
+ # @return [String]
1474
+ required :source, String
1475
+
1476
+ # @!attribute zoho_field
1477
+ # Destination Zoho field API name on the upserted record (e.g. 'Email', 'Company',
1478
+ # or a custom 'Budget\_\_c').
1479
+ #
1480
+ # @return [String]
1481
+ required :zoho_field, String
1482
+
1483
+ # @!method initialize(source:, zoho_field:)
1484
+ # Some parameter documentations has been truncated, see
1485
+ # {Revox::Models::AssistantListResponse::Assistant::Zoho::FieldMapping} for more
1486
+ # details.
1487
+ #
1488
+ # @param source [String] Source key to read from the call: a structured_output field name, falling back t
1489
+ #
1490
+ # @param zoho_field [String] Destination Zoho field API name on the upserted record (e.g. 'Email', 'Company',
1491
+ end
1492
+
1493
+ module Outcome
1494
+ extend Revox::Internal::Type::Enum
1495
+
1496
+ NOT_INTERESTED = :not_interested
1497
+ INTERESTED = :interested
1498
+ COMPLETED = :completed
1499
+ REQUESTED_CALLBACK_LATER = :requested_callback_later
1500
+ REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
1501
+ DO_NOT_CONTACT = :do_not_contact
1502
+ AI_AVERSE = :ai_averse
1503
+ NONE = :none
1504
+
1505
+ # @!method self.values
1506
+ # @return [Array<Symbol>]
1507
+ end
1508
+ end
1509
+
1510
+ # @see Revox::Models::AssistantListResponse::Assistant#created_by
1511
+ class CreatedBy < Revox::Internal::Type::BaseModel
1512
+ # @!attribute id
1513
+ # The database user id of the creator.
1514
+ #
1515
+ # @return [String]
1516
+ required :id, String
1517
+
1518
+ # @!attribute email
1519
+ #
1520
+ # @return [String]
1521
+ required :email, String
1522
+
1523
+ # @!attribute first_name
1524
+ #
1525
+ # @return [String, nil]
1526
+ required :first_name, String, nil?: true
1527
+
1528
+ # @!attribute last_name
1529
+ #
1530
+ # @return [String, nil]
1531
+ required :last_name, String, nil?: true
1532
+
1533
+ # @!method initialize(id:, email:, first_name:, last_name:)
1534
+ # The user who created the assistant.
1535
+ #
1536
+ # @param id [String] The database user id of the creator.
1537
+ #
1538
+ # @param email [String]
1539
+ #
1540
+ # @param first_name [String, nil]
1541
+ #
1542
+ # @param last_name [String, nil]
484
1543
  end
485
1544
 
486
1545
  class FaqItem < Revox::Internal::Type::BaseModel