vapi_server_sdk 0.4.0 → 0.5.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/lib/requests.rb +2 -2
- data/lib/types_export.rb +60 -14
- data/lib/vapi_server_sdk/analytics/client.rb +41 -12
- data/lib/vapi_server_sdk/assistants/client.rb +80 -14
- data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_server_messages_item.rb +1 -0
- data/lib/vapi_server_sdk/calls/client.rb +104 -6
- data/lib/vapi_server_sdk/logs/client.rb +2 -2
- data/lib/vapi_server_sdk/squads/client.rb +128 -8
- data/lib/vapi_server_sdk/test_suite_runs/client.rb +328 -0
- data/lib/vapi_server_sdk/test_suite_runs/types/test_suite_run_controller_find_all_paginated_request_sort_order.rb +10 -0
- data/lib/vapi_server_sdk/test_suite_tests/client.rb +331 -0
- data/lib/vapi_server_sdk/test_suite_tests/types/test_suite_test_controller_create_request.rb +81 -0
- data/lib/vapi_server_sdk/test_suite_tests/types/test_suite_test_controller_find_all_paginated_request_sort_order.rb +10 -0
- data/lib/vapi_server_sdk/test_suite_tests/types/test_suite_test_controller_remove_response.rb +82 -0
- data/lib/vapi_server_sdk/test_suite_tests/types/test_suite_test_controller_update_request.rb +81 -0
- data/lib/vapi_server_sdk/test_suites/client.rb +338 -0
- data/lib/vapi_server_sdk/test_suites/types/test_suite_controller_find_all_paginated_request_sort_order.rb +10 -0
- data/lib/vapi_server_sdk/types/{semantic_edge_condition.rb → ai_edge_condition.rb} +9 -11
- data/lib/vapi_server_sdk/types/analytics_operation_column.rb +1 -0
- data/lib/vapi_server_sdk/types/analytics_operation_operation.rb +1 -0
- data/lib/vapi_server_sdk/types/analytics_query.rb +4 -3
- data/lib/vapi_server_sdk/types/analytics_query_table.rb +9 -0
- data/lib/vapi_server_sdk/types/api_request.rb +165 -0
- data/lib/vapi_server_sdk/types/api_request_method.rb +8 -0
- data/lib/vapi_server_sdk/types/api_request_mode.rb +10 -0
- data/lib/vapi_server_sdk/types/artifact.rb +12 -2
- data/lib/vapi_server_sdk/types/artifact_plan.rb +56 -8
- data/lib/vapi_server_sdk/types/assistant.rb +27 -13
- data/lib/vapi_server_sdk/types/assistant_hook_action_base.rb +47 -0
- data/lib/vapi_server_sdk/types/assistant_hook_filter.rb +72 -0
- data/lib/vapi_server_sdk/types/assistant_hooks.rb +82 -0
- data/lib/vapi_server_sdk/types/assistant_overrides.rb +28 -14
- data/lib/vapi_server_sdk/types/assistant_overrides_server_messages_item.rb +1 -0
- data/lib/vapi_server_sdk/types/assistant_server_messages_item.rb +1 -0
- data/lib/vapi_server_sdk/types/azure_open_ai_credential_models_item.rb +1 -0
- data/lib/vapi_server_sdk/types/backoff_plan.rb +80 -0
- data/lib/vapi_server_sdk/types/byo_phone_number.rb +10 -1
- data/lib/vapi_server_sdk/types/byo_phone_number_status.rb +10 -0
- data/lib/vapi_server_sdk/types/call_ended_reason.rb +10 -1
- data/lib/vapi_server_sdk/types/cartesia_experimental_controls.rb +69 -0
- data/lib/vapi_server_sdk/types/cartesia_experimental_controls_emotion.rb +26 -0
- data/lib/vapi_server_sdk/types/cartesia_experimental_controls_speed.rb +11 -0
- data/lib/vapi_server_sdk/types/cartesia_voice.rb +24 -10
- data/lib/vapi_server_sdk/types/chat_completion_message.rb +80 -0
- data/lib/vapi_server_sdk/types/chat_completion_message_metadata.rb +94 -0
- data/lib/vapi_server_sdk/types/chat_completions_dto.rb +84 -0
- data/lib/vapi_server_sdk/types/client_inbound_message_transfer.rb +13 -3
- data/lib/vapi_server_sdk/types/client_message_conversation_update.rb +15 -2
- data/lib/vapi_server_sdk/types/client_message_hang.rb +22 -4
- data/lib/vapi_server_sdk/types/client_message_language_change_detected.rb +15 -3
- data/lib/vapi_server_sdk/types/client_message_message.rb +165 -181
- data/lib/vapi_server_sdk/types/client_message_metadata.rb +15 -3
- data/lib/vapi_server_sdk/types/client_message_model_output.rb +15 -3
- data/lib/vapi_server_sdk/types/client_message_speech_update.rb +11 -2
- data/lib/vapi_server_sdk/types/client_message_tool_calls.rb +15 -2
- data/lib/vapi_server_sdk/types/client_message_tool_calls_result.rb +15 -3
- data/lib/vapi_server_sdk/types/client_message_transcript.rb +12 -2
- data/lib/vapi_server_sdk/types/client_message_transcript_type.rb +10 -0
- data/lib/vapi_server_sdk/types/client_message_transfer_update.rb +11 -1
- data/lib/vapi_server_sdk/types/client_message_user_interrupted.rb +14 -4
- data/lib/vapi_server_sdk/types/client_message_voice_input.rb +15 -3
- data/lib/vapi_server_sdk/types/client_message_workflow_node_started.rb +67 -0
- data/lib/vapi_server_sdk/types/compliance_plan.rb +77 -0
- data/lib/vapi_server_sdk/types/create_assistant_dto.rb +28 -14
- data/lib/vapi_server_sdk/types/create_assistant_dto_server_messages_item.rb +1 -0
- data/lib/vapi_server_sdk/types/create_azure_open_ai_credential_dto_models_item.rb +1 -0
- data/lib/vapi_server_sdk/types/create_test_suite_test_voice_dto.rb +90 -0
- data/lib/vapi_server_sdk/types/create_vapi_phone_number_dto.rb +12 -4
- data/lib/vapi_server_sdk/types/create_workflow_dto.rb +2 -9
- data/lib/vapi_server_sdk/types/create_workflow_dto_nodes_item.rb +104 -52
- data/lib/vapi_server_sdk/types/deep_seek_model.rb +4 -3
- data/lib/vapi_server_sdk/types/deep_seek_model_model.rb +9 -0
- data/lib/vapi_server_sdk/types/deepgram_transcriber.rb +28 -2
- data/lib/vapi_server_sdk/types/deepgram_voice.rb +22 -2
- data/lib/vapi_server_sdk/types/edge.rb +9 -2
- data/lib/vapi_server_sdk/types/edge_condition.rb +32 -19
- data/lib/vapi_server_sdk/types/failed_edge_condition.rb +47 -0
- data/lib/vapi_server_sdk/types/fallback_cartesia_voice.rb +24 -9
- data/lib/vapi_server_sdk/types/fallback_deepgram_voice.rb +17 -2
- data/lib/vapi_server_sdk/types/fallback_play_ht_voice_model.rb +1 -0
- data/lib/vapi_server_sdk/types/fallback_rime_ai_voice_id_enum.rb +22 -20
- data/lib/vapi_server_sdk/types/fallback_rime_ai_voice_model.rb +1 -0
- data/lib/vapi_server_sdk/types/format_plan.rb +22 -2
- data/lib/vapi_server_sdk/types/format_plan_formatters_enabled_item.rb +22 -0
- data/lib/vapi_server_sdk/types/gather.rb +81 -25
- data/lib/vapi_server_sdk/types/google_model_model.rb +4 -0
- data/lib/vapi_server_sdk/types/groq_model_model.rb +1 -0
- data/lib/vapi_server_sdk/types/hangup.rb +67 -0
- data/lib/vapi_server_sdk/types/hook.rb +70 -0
- data/lib/vapi_server_sdk/types/hook_on.rb +9 -0
- data/lib/vapi_server_sdk/types/invite_user_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/json_schema.rb +26 -2
- data/lib/vapi_server_sdk/types/{programmatic_edge_condition.rb → logic_edge_condition.rb} +13 -15
- data/lib/vapi_server_sdk/types/message_plan.rb +12 -2
- data/lib/vapi_server_sdk/types/open_ai_model.rb +1 -9
- data/lib/vapi_server_sdk/types/open_ai_model_fallback_models_item.rb +2 -0
- data/lib/vapi_server_sdk/types/open_ai_model_model.rb +2 -0
- data/lib/vapi_server_sdk/types/play_ht_voice_model.rb +1 -0
- data/lib/vapi_server_sdk/types/rime_ai_voice_id_enum.rb +22 -20
- data/lib/vapi_server_sdk/types/rime_ai_voice_model.rb +1 -0
- data/lib/vapi_server_sdk/types/say.rb +23 -14
- data/lib/vapi_server_sdk/types/say_hook.rb +81 -0
- data/lib/vapi_server_sdk/types/server.rb +17 -2
- data/lib/vapi_server_sdk/types/server_message_assistant_request.rb +12 -2
- data/lib/vapi_server_sdk/types/server_message_conversation_update.rb +12 -2
- data/lib/vapi_server_sdk/types/server_message_end_of_call_report.rb +11 -1
- data/lib/vapi_server_sdk/types/server_message_end_of_call_report_ended_reason.rb +10 -1
- data/lib/vapi_server_sdk/types/server_message_hang.rb +20 -2
- data/lib/vapi_server_sdk/types/server_message_knowledge_base_request.rb +14 -2
- data/lib/vapi_server_sdk/types/server_message_language_change_detected.rb +11 -1
- data/lib/vapi_server_sdk/types/server_message_message.rb +212 -237
- data/lib/vapi_server_sdk/types/server_message_model_output.rb +11 -1
- data/lib/vapi_server_sdk/types/server_message_phone_call_control.rb +18 -2
- data/lib/vapi_server_sdk/types/server_message_speech_update.rb +11 -1
- data/lib/vapi_server_sdk/types/server_message_status_update.rb +12 -2
- data/lib/vapi_server_sdk/types/server_message_status_update_ended_reason.rb +10 -1
- data/lib/vapi_server_sdk/types/server_message_tool_calls.rb +10 -2
- data/lib/vapi_server_sdk/types/server_message_transcript.rb +13 -2
- data/lib/vapi_server_sdk/types/server_message_transcript_type.rb +10 -0
- data/lib/vapi_server_sdk/types/server_message_transfer_destination_request.rb +12 -2
- data/lib/vapi_server_sdk/types/server_message_transfer_update.rb +11 -1
- data/lib/vapi_server_sdk/types/server_message_user_interrupted.rb +12 -2
- data/lib/vapi_server_sdk/types/server_message_voice_input.rb +11 -1
- data/lib/vapi_server_sdk/types/server_message_voice_request.rb +50 -2
- data/lib/vapi_server_sdk/types/stop_speaking_plan.rb +27 -2
- data/lib/vapi_server_sdk/types/subscription.rb +33 -5
- data/lib/vapi_server_sdk/types/sync_voice_library_dto_providers_item.rb +1 -0
- data/lib/vapi_server_sdk/types/test_suite.rb +104 -0
- data/lib/vapi_server_sdk/types/test_suite_run.rb +127 -0
- data/lib/vapi_server_sdk/types/test_suite_run_scorer_ai.rb +80 -0
- data/lib/vapi_server_sdk/types/test_suite_run_scorer_ai_result.rb +9 -0
- data/lib/vapi_server_sdk/types/test_suite_run_status.rb +10 -0
- data/lib/vapi_server_sdk/types/test_suite_run_test_attempt.rb +75 -0
- data/lib/vapi_server_sdk/types/{analytics_query_dto.rb → test_suite_run_test_attempt_call.rb} +19 -17
- data/lib/vapi_server_sdk/types/test_suite_run_test_result.rb +75 -0
- data/lib/vapi_server_sdk/types/test_suite_runs_paginated_response.rb +75 -0
- data/lib/vapi_server_sdk/types/test_suite_test_scorer_ai.rb +65 -0
- data/lib/vapi_server_sdk/types/test_suite_test_voice.rb +132 -0
- data/lib/vapi_server_sdk/types/test_suite_tests_paginated_response.rb +75 -0
- data/lib/vapi_server_sdk/types/test_suites_paginated_response.rb +75 -0
- data/lib/vapi_server_sdk/types/time_range_step.rb +1 -0
- data/lib/vapi_server_sdk/types/tool_message_start.rb +18 -2
- data/lib/vapi_server_sdk/types/transfer.rb +74 -0
- data/lib/vapi_server_sdk/types/transfer_assistant_hook_action.rb +75 -0
- data/lib/vapi_server_sdk/types/{buy_phone_number_dto_fallback_destination.rb → transfer_assistant_hook_action_destination.rb} +9 -12
- data/lib/vapi_server_sdk/types/transfer_destination_assistant.rb +46 -0
- data/lib/vapi_server_sdk/types/transfer_plan.rb +37 -1
- data/lib/vapi_server_sdk/types/transfer_plan_mode.rb +4 -0
- data/lib/vapi_server_sdk/types/trieve_knowledge_base_search_plan.rb +12 -1
- data/lib/vapi_server_sdk/types/twilio_phone_number.rb +11 -2
- data/lib/vapi_server_sdk/types/twilio_phone_number_status.rb +10 -0
- data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto_models_item.rb +1 -0
- data/lib/vapi_server_sdk/types/update_test_suite_test_voice_dto.rb +90 -0
- data/lib/vapi_server_sdk/types/vapi_phone_number.rb +29 -4
- data/lib/vapi_server_sdk/types/vapi_phone_number_status.rb +10 -0
- data/lib/vapi_server_sdk/types/vonage_phone_number.rb +11 -2
- data/lib/vapi_server_sdk/types/vonage_phone_number_status.rb +10 -0
- data/lib/vapi_server_sdk/types/workflow.rb +1 -9
- data/lib/vapi_server_sdk/types/workflow_nodes_item.rb +104 -52
- data/lib/vapi_server_sdk/types/xai_model.rb +4 -3
- data/lib/vapi_server_sdk/types/xai_model_model.rb +10 -0
- data/lib/vapi_server_sdk.rb +21 -0
- metadata +61 -12
- data/lib/vapi_server_sdk/types/buy_phone_number_dto.rb +0 -147
- data/lib/vapi_server_sdk/types/org_with_org_user.rb +0 -262
- data/lib/vapi_server_sdk/types/org_with_org_user_channel.rb +0 -10
- data/lib/vapi_server_sdk/types/org_with_org_user_role.rb +0 -9
- data/lib/vapi_server_sdk/types/update_workflow_dto.rb +0 -82
- data/lib/vapi_server_sdk/types/update_workflow_dto_nodes_item.rb +0 -81
|
@@ -78,7 +78,6 @@ module Vapi
|
|
|
78
78
|
# * :voice (Hash)
|
|
79
79
|
# * :first_message (String)
|
|
80
80
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
|
81
|
-
# * :hipaa_enabled (Boolean)
|
|
82
81
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
|
83
82
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
|
84
83
|
# * :silence_timeout_seconds (Float)
|
|
@@ -101,6 +100,9 @@ module Vapi
|
|
|
101
100
|
# * :voicemail_message (String)
|
|
102
101
|
# * :end_call_message (String)
|
|
103
102
|
# * :end_call_phrases (Array<String>)
|
|
103
|
+
# * :compliance_plan (Hash)
|
|
104
|
+
# * :hipaa_enabled (Boolean)
|
|
105
|
+
# * :pci_enabled (Boolean)
|
|
104
106
|
# * :metadata (Hash{String => Object})
|
|
105
107
|
# * :analysis_plan (Hash)
|
|
106
108
|
# * :summary_plan (Hash)
|
|
@@ -116,6 +118,9 @@ module Vapi
|
|
|
116
118
|
# * :properties (Hash{String => Object})
|
|
117
119
|
# * :description (String)
|
|
118
120
|
# * :required (Array<String>)
|
|
121
|
+
# * :regex (String)
|
|
122
|
+
# * :value (String)
|
|
123
|
+
# * :target (String)
|
|
119
124
|
# * :enum (Array<String>)
|
|
120
125
|
# * :timeout_seconds (Float)
|
|
121
126
|
# * :success_evaluation_plan (Hash)
|
|
@@ -126,6 +131,8 @@ module Vapi
|
|
|
126
131
|
# * :artifact_plan (Hash)
|
|
127
132
|
# * :recording_enabled (Boolean)
|
|
128
133
|
# * :video_recording_enabled (Boolean)
|
|
134
|
+
# * :pcap_enabled (Boolean)
|
|
135
|
+
# * :pcap_s_3_path_prefix (String)
|
|
129
136
|
# * :transcript_plan (Hash)
|
|
130
137
|
# * :enabled (Boolean)
|
|
131
138
|
# * :assistant_name (String)
|
|
@@ -135,6 +142,7 @@ module Vapi
|
|
|
135
142
|
# * :idle_messages (Array<String>)
|
|
136
143
|
# * :idle_message_max_spoken_count (Float)
|
|
137
144
|
# * :idle_timeout_seconds (Float)
|
|
145
|
+
# * :silence_timeout_message (String)
|
|
138
146
|
# * :start_speaking_plan (Hash)
|
|
139
147
|
# * :wait_seconds (Float)
|
|
140
148
|
# * :smart_endpointing_enabled (Boolean)
|
|
@@ -147,6 +155,8 @@ module Vapi
|
|
|
147
155
|
# * :num_words (Float)
|
|
148
156
|
# * :voice_seconds (Float)
|
|
149
157
|
# * :backoff_seconds (Float)
|
|
158
|
+
# * :acknowledgement_phrases (Array<String>)
|
|
159
|
+
# * :interruption_phrases (Array<String>)
|
|
150
160
|
# * :monitor_plan (Hash)
|
|
151
161
|
# * :listen_enabled (Boolean)
|
|
152
162
|
# * :control_enabled (Boolean)
|
|
@@ -156,6 +166,11 @@ module Vapi
|
|
|
156
166
|
# * :url (String)
|
|
157
167
|
# * :secret (String)
|
|
158
168
|
# * :headers (Hash{String => Object})
|
|
169
|
+
# * :backoff_plan (Hash)
|
|
170
|
+
# * :max_retries (Float)
|
|
171
|
+
# * :type (Hash{String => Object})
|
|
172
|
+
# * :base_delay_seconds (Float)
|
|
173
|
+
# * :hooks (Array<Vapi::AssistantHooks>)
|
|
159
174
|
# @param request_options [Vapi::RequestOptions]
|
|
160
175
|
# @return [Vapi::Squad]
|
|
161
176
|
def create(request:, request_options: nil)
|
|
@@ -233,7 +248,6 @@ module Vapi
|
|
|
233
248
|
# * :voice (Hash)
|
|
234
249
|
# * :first_message (String)
|
|
235
250
|
# * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
|
|
236
|
-
# * :hipaa_enabled (Boolean)
|
|
237
251
|
# * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
|
|
238
252
|
# * :server_messages (Array<Vapi::CreateAssistantDtoServerMessagesItem>)
|
|
239
253
|
# * :silence_timeout_seconds (Float)
|
|
@@ -255,6 +269,9 @@ module Vapi
|
|
|
255
269
|
# * :voicemail_message (String)
|
|
256
270
|
# * :end_call_message (String)
|
|
257
271
|
# * :end_call_phrases (Array<String>)
|
|
272
|
+
# * :compliance_plan (Hash)
|
|
273
|
+
# * :hipaa_enabled (Boolean)
|
|
274
|
+
# * :pci_enabled (Boolean)
|
|
258
275
|
# * :metadata (Hash{String => Object})
|
|
259
276
|
# * :analysis_plan (Hash)
|
|
260
277
|
# * :summary_plan (Hash)
|
|
@@ -270,6 +287,9 @@ module Vapi
|
|
|
270
287
|
# * :properties (Hash{String => Object})
|
|
271
288
|
# * :description (String)
|
|
272
289
|
# * :required (Array<String>)
|
|
290
|
+
# * :regex (String)
|
|
291
|
+
# * :value (String)
|
|
292
|
+
# * :target (String)
|
|
273
293
|
# * :enum (Array<String>)
|
|
274
294
|
# * :timeout_seconds (Float)
|
|
275
295
|
# * :success_evaluation_plan (Hash)
|
|
@@ -280,6 +300,8 @@ module Vapi
|
|
|
280
300
|
# * :artifact_plan (Hash)
|
|
281
301
|
# * :recording_enabled (Boolean)
|
|
282
302
|
# * :video_recording_enabled (Boolean)
|
|
303
|
+
# * :pcap_enabled (Boolean)
|
|
304
|
+
# * :pcap_s_3_path_prefix (String)
|
|
283
305
|
# * :transcript_plan (Hash)
|
|
284
306
|
# * :enabled (Boolean)
|
|
285
307
|
# * :assistant_name (String)
|
|
@@ -289,6 +311,7 @@ module Vapi
|
|
|
289
311
|
# * :idle_messages (Array<String>)
|
|
290
312
|
# * :idle_message_max_spoken_count (Float)
|
|
291
313
|
# * :idle_timeout_seconds (Float)
|
|
314
|
+
# * :silence_timeout_message (String)
|
|
292
315
|
# * :start_speaking_plan (Hash)
|
|
293
316
|
# * :wait_seconds (Float)
|
|
294
317
|
# * :smart_endpointing_enabled (Boolean)
|
|
@@ -301,6 +324,8 @@ module Vapi
|
|
|
301
324
|
# * :num_words (Float)
|
|
302
325
|
# * :voice_seconds (Float)
|
|
303
326
|
# * :backoff_seconds (Float)
|
|
327
|
+
# * :acknowledgement_phrases (Array<String>)
|
|
328
|
+
# * :interruption_phrases (Array<String>)
|
|
304
329
|
# * :monitor_plan (Hash)
|
|
305
330
|
# * :listen_enabled (Boolean)
|
|
306
331
|
# * :control_enabled (Boolean)
|
|
@@ -310,13 +335,17 @@ module Vapi
|
|
|
310
335
|
# * :url (String)
|
|
311
336
|
# * :secret (String)
|
|
312
337
|
# * :headers (Hash{String => Object})
|
|
338
|
+
# * :backoff_plan (Hash)
|
|
339
|
+
# * :max_retries (Float)
|
|
340
|
+
# * :type (Hash{String => Object})
|
|
341
|
+
# * :base_delay_seconds (Float)
|
|
342
|
+
# * :hooks (Array<Vapi::AssistantHooks>)
|
|
313
343
|
# * :assistant_overrides (Hash)
|
|
314
344
|
# * :transcriber (Hash)
|
|
315
345
|
# * :model (Hash)
|
|
316
346
|
# * :voice (Hash)
|
|
317
347
|
# * :first_message (String)
|
|
318
348
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
|
319
|
-
# * :hipaa_enabled (Boolean)
|
|
320
349
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
|
321
350
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
|
322
351
|
# * :silence_timeout_seconds (Float)
|
|
@@ -339,6 +368,9 @@ module Vapi
|
|
|
339
368
|
# * :voicemail_message (String)
|
|
340
369
|
# * :end_call_message (String)
|
|
341
370
|
# * :end_call_phrases (Array<String>)
|
|
371
|
+
# * :compliance_plan (Hash)
|
|
372
|
+
# * :hipaa_enabled (Boolean)
|
|
373
|
+
# * :pci_enabled (Boolean)
|
|
342
374
|
# * :metadata (Hash{String => Object})
|
|
343
375
|
# * :analysis_plan (Hash)
|
|
344
376
|
# * :summary_plan (Hash)
|
|
@@ -354,6 +386,9 @@ module Vapi
|
|
|
354
386
|
# * :properties (Hash{String => Object})
|
|
355
387
|
# * :description (String)
|
|
356
388
|
# * :required (Array<String>)
|
|
389
|
+
# * :regex (String)
|
|
390
|
+
# * :value (String)
|
|
391
|
+
# * :target (String)
|
|
357
392
|
# * :enum (Array<String>)
|
|
358
393
|
# * :timeout_seconds (Float)
|
|
359
394
|
# * :success_evaluation_plan (Hash)
|
|
@@ -364,6 +399,8 @@ module Vapi
|
|
|
364
399
|
# * :artifact_plan (Hash)
|
|
365
400
|
# * :recording_enabled (Boolean)
|
|
366
401
|
# * :video_recording_enabled (Boolean)
|
|
402
|
+
# * :pcap_enabled (Boolean)
|
|
403
|
+
# * :pcap_s_3_path_prefix (String)
|
|
367
404
|
# * :transcript_plan (Hash)
|
|
368
405
|
# * :enabled (Boolean)
|
|
369
406
|
# * :assistant_name (String)
|
|
@@ -373,6 +410,7 @@ module Vapi
|
|
|
373
410
|
# * :idle_messages (Array<String>)
|
|
374
411
|
# * :idle_message_max_spoken_count (Float)
|
|
375
412
|
# * :idle_timeout_seconds (Float)
|
|
413
|
+
# * :silence_timeout_message (String)
|
|
376
414
|
# * :start_speaking_plan (Hash)
|
|
377
415
|
# * :wait_seconds (Float)
|
|
378
416
|
# * :smart_endpointing_enabled (Boolean)
|
|
@@ -385,6 +423,8 @@ module Vapi
|
|
|
385
423
|
# * :num_words (Float)
|
|
386
424
|
# * :voice_seconds (Float)
|
|
387
425
|
# * :backoff_seconds (Float)
|
|
426
|
+
# * :acknowledgement_phrases (Array<String>)
|
|
427
|
+
# * :interruption_phrases (Array<String>)
|
|
388
428
|
# * :monitor_plan (Hash)
|
|
389
429
|
# * :listen_enabled (Boolean)
|
|
390
430
|
# * :control_enabled (Boolean)
|
|
@@ -394,6 +434,11 @@ module Vapi
|
|
|
394
434
|
# * :url (String)
|
|
395
435
|
# * :secret (String)
|
|
396
436
|
# * :headers (Hash{String => Object})
|
|
437
|
+
# * :backoff_plan (Hash)
|
|
438
|
+
# * :max_retries (Float)
|
|
439
|
+
# * :type (Hash{String => Object})
|
|
440
|
+
# * :base_delay_seconds (Float)
|
|
441
|
+
# * :hooks (Array<Vapi::AssistantHooks>)
|
|
397
442
|
# * :assistant_destinations (Array<Vapi::TransferDestinationAssistant>)
|
|
398
443
|
# @param members_overrides [Hash] This can be used to override all the assistants' settings and provide values for
|
|
399
444
|
# their template variables.
|
|
@@ -405,7 +450,6 @@ module Vapi
|
|
|
405
450
|
# * :voice (Hash)
|
|
406
451
|
# * :first_message (String)
|
|
407
452
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
|
408
|
-
# * :hipaa_enabled (Boolean)
|
|
409
453
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
|
410
454
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
|
411
455
|
# * :silence_timeout_seconds (Float)
|
|
@@ -428,6 +472,9 @@ module Vapi
|
|
|
428
472
|
# * :voicemail_message (String)
|
|
429
473
|
# * :end_call_message (String)
|
|
430
474
|
# * :end_call_phrases (Array<String>)
|
|
475
|
+
# * :compliance_plan (Hash)
|
|
476
|
+
# * :hipaa_enabled (Boolean)
|
|
477
|
+
# * :pci_enabled (Boolean)
|
|
431
478
|
# * :metadata (Hash{String => Object})
|
|
432
479
|
# * :analysis_plan (Hash)
|
|
433
480
|
# * :summary_plan (Hash)
|
|
@@ -443,6 +490,9 @@ module Vapi
|
|
|
443
490
|
# * :properties (Hash{String => Object})
|
|
444
491
|
# * :description (String)
|
|
445
492
|
# * :required (Array<String>)
|
|
493
|
+
# * :regex (String)
|
|
494
|
+
# * :value (String)
|
|
495
|
+
# * :target (String)
|
|
446
496
|
# * :enum (Array<String>)
|
|
447
497
|
# * :timeout_seconds (Float)
|
|
448
498
|
# * :success_evaluation_plan (Hash)
|
|
@@ -453,6 +503,8 @@ module Vapi
|
|
|
453
503
|
# * :artifact_plan (Hash)
|
|
454
504
|
# * :recording_enabled (Boolean)
|
|
455
505
|
# * :video_recording_enabled (Boolean)
|
|
506
|
+
# * :pcap_enabled (Boolean)
|
|
507
|
+
# * :pcap_s_3_path_prefix (String)
|
|
456
508
|
# * :transcript_plan (Hash)
|
|
457
509
|
# * :enabled (Boolean)
|
|
458
510
|
# * :assistant_name (String)
|
|
@@ -462,6 +514,7 @@ module Vapi
|
|
|
462
514
|
# * :idle_messages (Array<String>)
|
|
463
515
|
# * :idle_message_max_spoken_count (Float)
|
|
464
516
|
# * :idle_timeout_seconds (Float)
|
|
517
|
+
# * :silence_timeout_message (String)
|
|
465
518
|
# * :start_speaking_plan (Hash)
|
|
466
519
|
# * :wait_seconds (Float)
|
|
467
520
|
# * :smart_endpointing_enabled (Boolean)
|
|
@@ -474,6 +527,8 @@ module Vapi
|
|
|
474
527
|
# * :num_words (Float)
|
|
475
528
|
# * :voice_seconds (Float)
|
|
476
529
|
# * :backoff_seconds (Float)
|
|
530
|
+
# * :acknowledgement_phrases (Array<String>)
|
|
531
|
+
# * :interruption_phrases (Array<String>)
|
|
477
532
|
# * :monitor_plan (Hash)
|
|
478
533
|
# * :listen_enabled (Boolean)
|
|
479
534
|
# * :control_enabled (Boolean)
|
|
@@ -483,6 +538,11 @@ module Vapi
|
|
|
483
538
|
# * :url (String)
|
|
484
539
|
# * :secret (String)
|
|
485
540
|
# * :headers (Hash{String => Object})
|
|
541
|
+
# * :backoff_plan (Hash)
|
|
542
|
+
# * :max_retries (Float)
|
|
543
|
+
# * :type (Hash{String => Object})
|
|
544
|
+
# * :base_delay_seconds (Float)
|
|
545
|
+
# * :hooks (Array<Vapi::AssistantHooks>)
|
|
486
546
|
# @param request_options [Vapi::RequestOptions]
|
|
487
547
|
# @return [Vapi::Squad]
|
|
488
548
|
def update(id:, members:, name: nil, members_overrides: nil, request_options: nil)
|
|
@@ -579,7 +639,6 @@ module Vapi
|
|
|
579
639
|
# * :voice (Hash)
|
|
580
640
|
# * :first_message (String)
|
|
581
641
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
|
582
|
-
# * :hipaa_enabled (Boolean)
|
|
583
642
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
|
584
643
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
|
585
644
|
# * :silence_timeout_seconds (Float)
|
|
@@ -602,6 +661,9 @@ module Vapi
|
|
|
602
661
|
# * :voicemail_message (String)
|
|
603
662
|
# * :end_call_message (String)
|
|
604
663
|
# * :end_call_phrases (Array<String>)
|
|
664
|
+
# * :compliance_plan (Hash)
|
|
665
|
+
# * :hipaa_enabled (Boolean)
|
|
666
|
+
# * :pci_enabled (Boolean)
|
|
605
667
|
# * :metadata (Hash{String => Object})
|
|
606
668
|
# * :analysis_plan (Hash)
|
|
607
669
|
# * :summary_plan (Hash)
|
|
@@ -617,6 +679,9 @@ module Vapi
|
|
|
617
679
|
# * :properties (Hash{String => Object})
|
|
618
680
|
# * :description (String)
|
|
619
681
|
# * :required (Array<String>)
|
|
682
|
+
# * :regex (String)
|
|
683
|
+
# * :value (String)
|
|
684
|
+
# * :target (String)
|
|
620
685
|
# * :enum (Array<String>)
|
|
621
686
|
# * :timeout_seconds (Float)
|
|
622
687
|
# * :success_evaluation_plan (Hash)
|
|
@@ -627,6 +692,8 @@ module Vapi
|
|
|
627
692
|
# * :artifact_plan (Hash)
|
|
628
693
|
# * :recording_enabled (Boolean)
|
|
629
694
|
# * :video_recording_enabled (Boolean)
|
|
695
|
+
# * :pcap_enabled (Boolean)
|
|
696
|
+
# * :pcap_s_3_path_prefix (String)
|
|
630
697
|
# * :transcript_plan (Hash)
|
|
631
698
|
# * :enabled (Boolean)
|
|
632
699
|
# * :assistant_name (String)
|
|
@@ -636,6 +703,7 @@ module Vapi
|
|
|
636
703
|
# * :idle_messages (Array<String>)
|
|
637
704
|
# * :idle_message_max_spoken_count (Float)
|
|
638
705
|
# * :idle_timeout_seconds (Float)
|
|
706
|
+
# * :silence_timeout_message (String)
|
|
639
707
|
# * :start_speaking_plan (Hash)
|
|
640
708
|
# * :wait_seconds (Float)
|
|
641
709
|
# * :smart_endpointing_enabled (Boolean)
|
|
@@ -648,6 +716,8 @@ module Vapi
|
|
|
648
716
|
# * :num_words (Float)
|
|
649
717
|
# * :voice_seconds (Float)
|
|
650
718
|
# * :backoff_seconds (Float)
|
|
719
|
+
# * :acknowledgement_phrases (Array<String>)
|
|
720
|
+
# * :interruption_phrases (Array<String>)
|
|
651
721
|
# * :monitor_plan (Hash)
|
|
652
722
|
# * :listen_enabled (Boolean)
|
|
653
723
|
# * :control_enabled (Boolean)
|
|
@@ -657,6 +727,11 @@ module Vapi
|
|
|
657
727
|
# * :url (String)
|
|
658
728
|
# * :secret (String)
|
|
659
729
|
# * :headers (Hash{String => Object})
|
|
730
|
+
# * :backoff_plan (Hash)
|
|
731
|
+
# * :max_retries (Float)
|
|
732
|
+
# * :type (Hash{String => Object})
|
|
733
|
+
# * :base_delay_seconds (Float)
|
|
734
|
+
# * :hooks (Array<Vapi::AssistantHooks>)
|
|
660
735
|
# @param request_options [Vapi::RequestOptions]
|
|
661
736
|
# @return [Vapi::Squad]
|
|
662
737
|
def create(request:, request_options: nil)
|
|
@@ -740,7 +815,6 @@ module Vapi
|
|
|
740
815
|
# * :voice (Hash)
|
|
741
816
|
# * :first_message (String)
|
|
742
817
|
# * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
|
|
743
|
-
# * :hipaa_enabled (Boolean)
|
|
744
818
|
# * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
|
|
745
819
|
# * :server_messages (Array<Vapi::CreateAssistantDtoServerMessagesItem>)
|
|
746
820
|
# * :silence_timeout_seconds (Float)
|
|
@@ -762,6 +836,9 @@ module Vapi
|
|
|
762
836
|
# * :voicemail_message (String)
|
|
763
837
|
# * :end_call_message (String)
|
|
764
838
|
# * :end_call_phrases (Array<String>)
|
|
839
|
+
# * :compliance_plan (Hash)
|
|
840
|
+
# * :hipaa_enabled (Boolean)
|
|
841
|
+
# * :pci_enabled (Boolean)
|
|
765
842
|
# * :metadata (Hash{String => Object})
|
|
766
843
|
# * :analysis_plan (Hash)
|
|
767
844
|
# * :summary_plan (Hash)
|
|
@@ -777,6 +854,9 @@ module Vapi
|
|
|
777
854
|
# * :properties (Hash{String => Object})
|
|
778
855
|
# * :description (String)
|
|
779
856
|
# * :required (Array<String>)
|
|
857
|
+
# * :regex (String)
|
|
858
|
+
# * :value (String)
|
|
859
|
+
# * :target (String)
|
|
780
860
|
# * :enum (Array<String>)
|
|
781
861
|
# * :timeout_seconds (Float)
|
|
782
862
|
# * :success_evaluation_plan (Hash)
|
|
@@ -787,6 +867,8 @@ module Vapi
|
|
|
787
867
|
# * :artifact_plan (Hash)
|
|
788
868
|
# * :recording_enabled (Boolean)
|
|
789
869
|
# * :video_recording_enabled (Boolean)
|
|
870
|
+
# * :pcap_enabled (Boolean)
|
|
871
|
+
# * :pcap_s_3_path_prefix (String)
|
|
790
872
|
# * :transcript_plan (Hash)
|
|
791
873
|
# * :enabled (Boolean)
|
|
792
874
|
# * :assistant_name (String)
|
|
@@ -796,6 +878,7 @@ module Vapi
|
|
|
796
878
|
# * :idle_messages (Array<String>)
|
|
797
879
|
# * :idle_message_max_spoken_count (Float)
|
|
798
880
|
# * :idle_timeout_seconds (Float)
|
|
881
|
+
# * :silence_timeout_message (String)
|
|
799
882
|
# * :start_speaking_plan (Hash)
|
|
800
883
|
# * :wait_seconds (Float)
|
|
801
884
|
# * :smart_endpointing_enabled (Boolean)
|
|
@@ -808,6 +891,8 @@ module Vapi
|
|
|
808
891
|
# * :num_words (Float)
|
|
809
892
|
# * :voice_seconds (Float)
|
|
810
893
|
# * :backoff_seconds (Float)
|
|
894
|
+
# * :acknowledgement_phrases (Array<String>)
|
|
895
|
+
# * :interruption_phrases (Array<String>)
|
|
811
896
|
# * :monitor_plan (Hash)
|
|
812
897
|
# * :listen_enabled (Boolean)
|
|
813
898
|
# * :control_enabled (Boolean)
|
|
@@ -817,13 +902,17 @@ module Vapi
|
|
|
817
902
|
# * :url (String)
|
|
818
903
|
# * :secret (String)
|
|
819
904
|
# * :headers (Hash{String => Object})
|
|
905
|
+
# * :backoff_plan (Hash)
|
|
906
|
+
# * :max_retries (Float)
|
|
907
|
+
# * :type (Hash{String => Object})
|
|
908
|
+
# * :base_delay_seconds (Float)
|
|
909
|
+
# * :hooks (Array<Vapi::AssistantHooks>)
|
|
820
910
|
# * :assistant_overrides (Hash)
|
|
821
911
|
# * :transcriber (Hash)
|
|
822
912
|
# * :model (Hash)
|
|
823
913
|
# * :voice (Hash)
|
|
824
914
|
# * :first_message (String)
|
|
825
915
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
|
826
|
-
# * :hipaa_enabled (Boolean)
|
|
827
916
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
|
828
917
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
|
829
918
|
# * :silence_timeout_seconds (Float)
|
|
@@ -846,6 +935,9 @@ module Vapi
|
|
|
846
935
|
# * :voicemail_message (String)
|
|
847
936
|
# * :end_call_message (String)
|
|
848
937
|
# * :end_call_phrases (Array<String>)
|
|
938
|
+
# * :compliance_plan (Hash)
|
|
939
|
+
# * :hipaa_enabled (Boolean)
|
|
940
|
+
# * :pci_enabled (Boolean)
|
|
849
941
|
# * :metadata (Hash{String => Object})
|
|
850
942
|
# * :analysis_plan (Hash)
|
|
851
943
|
# * :summary_plan (Hash)
|
|
@@ -861,6 +953,9 @@ module Vapi
|
|
|
861
953
|
# * :properties (Hash{String => Object})
|
|
862
954
|
# * :description (String)
|
|
863
955
|
# * :required (Array<String>)
|
|
956
|
+
# * :regex (String)
|
|
957
|
+
# * :value (String)
|
|
958
|
+
# * :target (String)
|
|
864
959
|
# * :enum (Array<String>)
|
|
865
960
|
# * :timeout_seconds (Float)
|
|
866
961
|
# * :success_evaluation_plan (Hash)
|
|
@@ -871,6 +966,8 @@ module Vapi
|
|
|
871
966
|
# * :artifact_plan (Hash)
|
|
872
967
|
# * :recording_enabled (Boolean)
|
|
873
968
|
# * :video_recording_enabled (Boolean)
|
|
969
|
+
# * :pcap_enabled (Boolean)
|
|
970
|
+
# * :pcap_s_3_path_prefix (String)
|
|
874
971
|
# * :transcript_plan (Hash)
|
|
875
972
|
# * :enabled (Boolean)
|
|
876
973
|
# * :assistant_name (String)
|
|
@@ -880,6 +977,7 @@ module Vapi
|
|
|
880
977
|
# * :idle_messages (Array<String>)
|
|
881
978
|
# * :idle_message_max_spoken_count (Float)
|
|
882
979
|
# * :idle_timeout_seconds (Float)
|
|
980
|
+
# * :silence_timeout_message (String)
|
|
883
981
|
# * :start_speaking_plan (Hash)
|
|
884
982
|
# * :wait_seconds (Float)
|
|
885
983
|
# * :smart_endpointing_enabled (Boolean)
|
|
@@ -892,6 +990,8 @@ module Vapi
|
|
|
892
990
|
# * :num_words (Float)
|
|
893
991
|
# * :voice_seconds (Float)
|
|
894
992
|
# * :backoff_seconds (Float)
|
|
993
|
+
# * :acknowledgement_phrases (Array<String>)
|
|
994
|
+
# * :interruption_phrases (Array<String>)
|
|
895
995
|
# * :monitor_plan (Hash)
|
|
896
996
|
# * :listen_enabled (Boolean)
|
|
897
997
|
# * :control_enabled (Boolean)
|
|
@@ -901,6 +1001,11 @@ module Vapi
|
|
|
901
1001
|
# * :url (String)
|
|
902
1002
|
# * :secret (String)
|
|
903
1003
|
# * :headers (Hash{String => Object})
|
|
1004
|
+
# * :backoff_plan (Hash)
|
|
1005
|
+
# * :max_retries (Float)
|
|
1006
|
+
# * :type (Hash{String => Object})
|
|
1007
|
+
# * :base_delay_seconds (Float)
|
|
1008
|
+
# * :hooks (Array<Vapi::AssistantHooks>)
|
|
904
1009
|
# * :assistant_destinations (Array<Vapi::TransferDestinationAssistant>)
|
|
905
1010
|
# @param members_overrides [Hash] This can be used to override all the assistants' settings and provide values for
|
|
906
1011
|
# their template variables.
|
|
@@ -912,7 +1017,6 @@ module Vapi
|
|
|
912
1017
|
# * :voice (Hash)
|
|
913
1018
|
# * :first_message (String)
|
|
914
1019
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
|
915
|
-
# * :hipaa_enabled (Boolean)
|
|
916
1020
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
|
917
1021
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
|
918
1022
|
# * :silence_timeout_seconds (Float)
|
|
@@ -935,6 +1039,9 @@ module Vapi
|
|
|
935
1039
|
# * :voicemail_message (String)
|
|
936
1040
|
# * :end_call_message (String)
|
|
937
1041
|
# * :end_call_phrases (Array<String>)
|
|
1042
|
+
# * :compliance_plan (Hash)
|
|
1043
|
+
# * :hipaa_enabled (Boolean)
|
|
1044
|
+
# * :pci_enabled (Boolean)
|
|
938
1045
|
# * :metadata (Hash{String => Object})
|
|
939
1046
|
# * :analysis_plan (Hash)
|
|
940
1047
|
# * :summary_plan (Hash)
|
|
@@ -950,6 +1057,9 @@ module Vapi
|
|
|
950
1057
|
# * :properties (Hash{String => Object})
|
|
951
1058
|
# * :description (String)
|
|
952
1059
|
# * :required (Array<String>)
|
|
1060
|
+
# * :regex (String)
|
|
1061
|
+
# * :value (String)
|
|
1062
|
+
# * :target (String)
|
|
953
1063
|
# * :enum (Array<String>)
|
|
954
1064
|
# * :timeout_seconds (Float)
|
|
955
1065
|
# * :success_evaluation_plan (Hash)
|
|
@@ -960,6 +1070,8 @@ module Vapi
|
|
|
960
1070
|
# * :artifact_plan (Hash)
|
|
961
1071
|
# * :recording_enabled (Boolean)
|
|
962
1072
|
# * :video_recording_enabled (Boolean)
|
|
1073
|
+
# * :pcap_enabled (Boolean)
|
|
1074
|
+
# * :pcap_s_3_path_prefix (String)
|
|
963
1075
|
# * :transcript_plan (Hash)
|
|
964
1076
|
# * :enabled (Boolean)
|
|
965
1077
|
# * :assistant_name (String)
|
|
@@ -969,6 +1081,7 @@ module Vapi
|
|
|
969
1081
|
# * :idle_messages (Array<String>)
|
|
970
1082
|
# * :idle_message_max_spoken_count (Float)
|
|
971
1083
|
# * :idle_timeout_seconds (Float)
|
|
1084
|
+
# * :silence_timeout_message (String)
|
|
972
1085
|
# * :start_speaking_plan (Hash)
|
|
973
1086
|
# * :wait_seconds (Float)
|
|
974
1087
|
# * :smart_endpointing_enabled (Boolean)
|
|
@@ -981,6 +1094,8 @@ module Vapi
|
|
|
981
1094
|
# * :num_words (Float)
|
|
982
1095
|
# * :voice_seconds (Float)
|
|
983
1096
|
# * :backoff_seconds (Float)
|
|
1097
|
+
# * :acknowledgement_phrases (Array<String>)
|
|
1098
|
+
# * :interruption_phrases (Array<String>)
|
|
984
1099
|
# * :monitor_plan (Hash)
|
|
985
1100
|
# * :listen_enabled (Boolean)
|
|
986
1101
|
# * :control_enabled (Boolean)
|
|
@@ -990,6 +1105,11 @@ module Vapi
|
|
|
990
1105
|
# * :url (String)
|
|
991
1106
|
# * :secret (String)
|
|
992
1107
|
# * :headers (Hash{String => Object})
|
|
1108
|
+
# * :backoff_plan (Hash)
|
|
1109
|
+
# * :max_retries (Float)
|
|
1110
|
+
# * :type (Hash{String => Object})
|
|
1111
|
+
# * :base_delay_seconds (Float)
|
|
1112
|
+
# * :hooks (Array<Vapi::AssistantHooks>)
|
|
993
1113
|
# @param request_options [Vapi::RequestOptions]
|
|
994
1114
|
# @return [Vapi::Squad]
|
|
995
1115
|
def update(id:, members:, name: nil, members_overrides: nil, request_options: nil)
|