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
@@ -89,7 +89,6 @@ module Vapi
|
|
89
89
|
# * :voice (Hash)
|
90
90
|
# * :first_message (String)
|
91
91
|
# * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
|
92
|
-
# * :hipaa_enabled (Boolean)
|
93
92
|
# * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
|
94
93
|
# * :server_messages (Array<Vapi::CreateAssistantDtoServerMessagesItem>)
|
95
94
|
# * :silence_timeout_seconds (Float)
|
@@ -111,6 +110,9 @@ module Vapi
|
|
111
110
|
# * :voicemail_message (String)
|
112
111
|
# * :end_call_message (String)
|
113
112
|
# * :end_call_phrases (Array<String>)
|
113
|
+
# * :compliance_plan (Hash)
|
114
|
+
# * :hipaa_enabled (Boolean)
|
115
|
+
# * :pci_enabled (Boolean)
|
114
116
|
# * :metadata (Hash{String => Object})
|
115
117
|
# * :analysis_plan (Hash)
|
116
118
|
# * :summary_plan (Hash)
|
@@ -126,6 +128,9 @@ module Vapi
|
|
126
128
|
# * :properties (Hash{String => Object})
|
127
129
|
# * :description (String)
|
128
130
|
# * :required (Array<String>)
|
131
|
+
# * :regex (String)
|
132
|
+
# * :value (String)
|
133
|
+
# * :target (String)
|
129
134
|
# * :enum (Array<String>)
|
130
135
|
# * :timeout_seconds (Float)
|
131
136
|
# * :success_evaluation_plan (Hash)
|
@@ -136,6 +141,8 @@ module Vapi
|
|
136
141
|
# * :artifact_plan (Hash)
|
137
142
|
# * :recording_enabled (Boolean)
|
138
143
|
# * :video_recording_enabled (Boolean)
|
144
|
+
# * :pcap_enabled (Boolean)
|
145
|
+
# * :pcap_s_3_path_prefix (String)
|
139
146
|
# * :transcript_plan (Hash)
|
140
147
|
# * :enabled (Boolean)
|
141
148
|
# * :assistant_name (String)
|
@@ -145,6 +152,7 @@ module Vapi
|
|
145
152
|
# * :idle_messages (Array<String>)
|
146
153
|
# * :idle_message_max_spoken_count (Float)
|
147
154
|
# * :idle_timeout_seconds (Float)
|
155
|
+
# * :silence_timeout_message (String)
|
148
156
|
# * :start_speaking_plan (Hash)
|
149
157
|
# * :wait_seconds (Float)
|
150
158
|
# * :smart_endpointing_enabled (Boolean)
|
@@ -157,6 +165,8 @@ module Vapi
|
|
157
165
|
# * :num_words (Float)
|
158
166
|
# * :voice_seconds (Float)
|
159
167
|
# * :backoff_seconds (Float)
|
168
|
+
# * :acknowledgement_phrases (Array<String>)
|
169
|
+
# * :interruption_phrases (Array<String>)
|
160
170
|
# * :monitor_plan (Hash)
|
161
171
|
# * :listen_enabled (Boolean)
|
162
172
|
# * :control_enabled (Boolean)
|
@@ -166,6 +176,11 @@ module Vapi
|
|
166
176
|
# * :url (String)
|
167
177
|
# * :secret (String)
|
168
178
|
# * :headers (Hash{String => Object})
|
179
|
+
# * :backoff_plan (Hash)
|
180
|
+
# * :max_retries (Float)
|
181
|
+
# * :type (Hash{String => Object})
|
182
|
+
# * :base_delay_seconds (Float)
|
183
|
+
# * :hooks (Array<Vapi::AssistantHooks>)
|
169
184
|
# @param assistant_overrides [Hash] These are the overrides for the `assistant` or `assistantId`'s settings and
|
170
185
|
# template variables.Request of type Vapi::AssistantOverrides, as a Hash
|
171
186
|
# * :transcriber (Hash)
|
@@ -173,7 +188,6 @@ module Vapi
|
|
173
188
|
# * :voice (Hash)
|
174
189
|
# * :first_message (String)
|
175
190
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
176
|
-
# * :hipaa_enabled (Boolean)
|
177
191
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
178
192
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
179
193
|
# * :silence_timeout_seconds (Float)
|
@@ -196,6 +210,9 @@ module Vapi
|
|
196
210
|
# * :voicemail_message (String)
|
197
211
|
# * :end_call_message (String)
|
198
212
|
# * :end_call_phrases (Array<String>)
|
213
|
+
# * :compliance_plan (Hash)
|
214
|
+
# * :hipaa_enabled (Boolean)
|
215
|
+
# * :pci_enabled (Boolean)
|
199
216
|
# * :metadata (Hash{String => Object})
|
200
217
|
# * :analysis_plan (Hash)
|
201
218
|
# * :summary_plan (Hash)
|
@@ -211,6 +228,9 @@ module Vapi
|
|
211
228
|
# * :properties (Hash{String => Object})
|
212
229
|
# * :description (String)
|
213
230
|
# * :required (Array<String>)
|
231
|
+
# * :regex (String)
|
232
|
+
# * :value (String)
|
233
|
+
# * :target (String)
|
214
234
|
# * :enum (Array<String>)
|
215
235
|
# * :timeout_seconds (Float)
|
216
236
|
# * :success_evaluation_plan (Hash)
|
@@ -221,6 +241,8 @@ module Vapi
|
|
221
241
|
# * :artifact_plan (Hash)
|
222
242
|
# * :recording_enabled (Boolean)
|
223
243
|
# * :video_recording_enabled (Boolean)
|
244
|
+
# * :pcap_enabled (Boolean)
|
245
|
+
# * :pcap_s_3_path_prefix (String)
|
224
246
|
# * :transcript_plan (Hash)
|
225
247
|
# * :enabled (Boolean)
|
226
248
|
# * :assistant_name (String)
|
@@ -230,6 +252,7 @@ module Vapi
|
|
230
252
|
# * :idle_messages (Array<String>)
|
231
253
|
# * :idle_message_max_spoken_count (Float)
|
232
254
|
# * :idle_timeout_seconds (Float)
|
255
|
+
# * :silence_timeout_message (String)
|
233
256
|
# * :start_speaking_plan (Hash)
|
234
257
|
# * :wait_seconds (Float)
|
235
258
|
# * :smart_endpointing_enabled (Boolean)
|
@@ -242,6 +265,8 @@ module Vapi
|
|
242
265
|
# * :num_words (Float)
|
243
266
|
# * :voice_seconds (Float)
|
244
267
|
# * :backoff_seconds (Float)
|
268
|
+
# * :acknowledgement_phrases (Array<String>)
|
269
|
+
# * :interruption_phrases (Array<String>)
|
245
270
|
# * :monitor_plan (Hash)
|
246
271
|
# * :listen_enabled (Boolean)
|
247
272
|
# * :control_enabled (Boolean)
|
@@ -251,6 +276,11 @@ module Vapi
|
|
251
276
|
# * :url (String)
|
252
277
|
# * :secret (String)
|
253
278
|
# * :headers (Hash{String => Object})
|
279
|
+
# * :backoff_plan (Hash)
|
280
|
+
# * :max_retries (Float)
|
281
|
+
# * :type (Hash{String => Object})
|
282
|
+
# * :base_delay_seconds (Float)
|
283
|
+
# * :hooks (Array<Vapi::AssistantHooks>)
|
254
284
|
# @param squad_id [String] This is the squad that will be used for the call. To use a transient squad, use
|
255
285
|
# `squad` instead.
|
256
286
|
# @param squad [Hash] This is a squad that will be used for the call. To use an existing squad, use
|
@@ -263,7 +293,6 @@ module Vapi
|
|
263
293
|
# * :voice (Hash)
|
264
294
|
# * :first_message (String)
|
265
295
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
266
|
-
# * :hipaa_enabled (Boolean)
|
267
296
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
268
297
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
269
298
|
# * :silence_timeout_seconds (Float)
|
@@ -286,6 +315,9 @@ module Vapi
|
|
286
315
|
# * :voicemail_message (String)
|
287
316
|
# * :end_call_message (String)
|
288
317
|
# * :end_call_phrases (Array<String>)
|
318
|
+
# * :compliance_plan (Hash)
|
319
|
+
# * :hipaa_enabled (Boolean)
|
320
|
+
# * :pci_enabled (Boolean)
|
289
321
|
# * :metadata (Hash{String => Object})
|
290
322
|
# * :analysis_plan (Hash)
|
291
323
|
# * :summary_plan (Hash)
|
@@ -301,6 +333,9 @@ module Vapi
|
|
301
333
|
# * :properties (Hash{String => Object})
|
302
334
|
# * :description (String)
|
303
335
|
# * :required (Array<String>)
|
336
|
+
# * :regex (String)
|
337
|
+
# * :value (String)
|
338
|
+
# * :target (String)
|
304
339
|
# * :enum (Array<String>)
|
305
340
|
# * :timeout_seconds (Float)
|
306
341
|
# * :success_evaluation_plan (Hash)
|
@@ -311,6 +346,8 @@ module Vapi
|
|
311
346
|
# * :artifact_plan (Hash)
|
312
347
|
# * :recording_enabled (Boolean)
|
313
348
|
# * :video_recording_enabled (Boolean)
|
349
|
+
# * :pcap_enabled (Boolean)
|
350
|
+
# * :pcap_s_3_path_prefix (String)
|
314
351
|
# * :transcript_plan (Hash)
|
315
352
|
# * :enabled (Boolean)
|
316
353
|
# * :assistant_name (String)
|
@@ -320,6 +357,7 @@ module Vapi
|
|
320
357
|
# * :idle_messages (Array<String>)
|
321
358
|
# * :idle_message_max_spoken_count (Float)
|
322
359
|
# * :idle_timeout_seconds (Float)
|
360
|
+
# * :silence_timeout_message (String)
|
323
361
|
# * :start_speaking_plan (Hash)
|
324
362
|
# * :wait_seconds (Float)
|
325
363
|
# * :smart_endpointing_enabled (Boolean)
|
@@ -332,6 +370,8 @@ module Vapi
|
|
332
370
|
# * :num_words (Float)
|
333
371
|
# * :voice_seconds (Float)
|
334
372
|
# * :backoff_seconds (Float)
|
373
|
+
# * :acknowledgement_phrases (Array<String>)
|
374
|
+
# * :interruption_phrases (Array<String>)
|
335
375
|
# * :monitor_plan (Hash)
|
336
376
|
# * :listen_enabled (Boolean)
|
337
377
|
# * :control_enabled (Boolean)
|
@@ -341,6 +381,11 @@ module Vapi
|
|
341
381
|
# * :url (String)
|
342
382
|
# * :secret (String)
|
343
383
|
# * :headers (Hash{String => Object})
|
384
|
+
# * :backoff_plan (Hash)
|
385
|
+
# * :max_retries (Float)
|
386
|
+
# * :type (Hash{String => Object})
|
387
|
+
# * :base_delay_seconds (Float)
|
388
|
+
# * :hooks (Array<Vapi::AssistantHooks>)
|
344
389
|
# @param phone_number_id [String] This is the phone number that will be used for the call. To use a transient
|
345
390
|
# number, use `phoneNumber` instead.
|
346
391
|
# Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
|
@@ -359,6 +404,10 @@ module Vapi
|
|
359
404
|
# * :url (String)
|
360
405
|
# * :secret (String)
|
361
406
|
# * :headers (Hash{String => Object})
|
407
|
+
# * :backoff_plan (Hash)
|
408
|
+
# * :max_retries (Float)
|
409
|
+
# * :type (Hash{String => Object})
|
410
|
+
# * :base_delay_seconds (Float)
|
362
411
|
# @param customer_id [String] This is the customer that will be called. To call a transient customer , use
|
363
412
|
# `customer` instead.
|
364
413
|
# Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
|
@@ -551,7 +600,6 @@ module Vapi
|
|
551
600
|
# * :voice (Hash)
|
552
601
|
# * :first_message (String)
|
553
602
|
# * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
|
554
|
-
# * :hipaa_enabled (Boolean)
|
555
603
|
# * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
|
556
604
|
# * :server_messages (Array<Vapi::CreateAssistantDtoServerMessagesItem>)
|
557
605
|
# * :silence_timeout_seconds (Float)
|
@@ -573,6 +621,9 @@ module Vapi
|
|
573
621
|
# * :voicemail_message (String)
|
574
622
|
# * :end_call_message (String)
|
575
623
|
# * :end_call_phrases (Array<String>)
|
624
|
+
# * :compliance_plan (Hash)
|
625
|
+
# * :hipaa_enabled (Boolean)
|
626
|
+
# * :pci_enabled (Boolean)
|
576
627
|
# * :metadata (Hash{String => Object})
|
577
628
|
# * :analysis_plan (Hash)
|
578
629
|
# * :summary_plan (Hash)
|
@@ -588,6 +639,9 @@ module Vapi
|
|
588
639
|
# * :properties (Hash{String => Object})
|
589
640
|
# * :description (String)
|
590
641
|
# * :required (Array<String>)
|
642
|
+
# * :regex (String)
|
643
|
+
# * :value (String)
|
644
|
+
# * :target (String)
|
591
645
|
# * :enum (Array<String>)
|
592
646
|
# * :timeout_seconds (Float)
|
593
647
|
# * :success_evaluation_plan (Hash)
|
@@ -598,6 +652,8 @@ module Vapi
|
|
598
652
|
# * :artifact_plan (Hash)
|
599
653
|
# * :recording_enabled (Boolean)
|
600
654
|
# * :video_recording_enabled (Boolean)
|
655
|
+
# * :pcap_enabled (Boolean)
|
656
|
+
# * :pcap_s_3_path_prefix (String)
|
601
657
|
# * :transcript_plan (Hash)
|
602
658
|
# * :enabled (Boolean)
|
603
659
|
# * :assistant_name (String)
|
@@ -607,6 +663,7 @@ module Vapi
|
|
607
663
|
# * :idle_messages (Array<String>)
|
608
664
|
# * :idle_message_max_spoken_count (Float)
|
609
665
|
# * :idle_timeout_seconds (Float)
|
666
|
+
# * :silence_timeout_message (String)
|
610
667
|
# * :start_speaking_plan (Hash)
|
611
668
|
# * :wait_seconds (Float)
|
612
669
|
# * :smart_endpointing_enabled (Boolean)
|
@@ -619,6 +676,8 @@ module Vapi
|
|
619
676
|
# * :num_words (Float)
|
620
677
|
# * :voice_seconds (Float)
|
621
678
|
# * :backoff_seconds (Float)
|
679
|
+
# * :acknowledgement_phrases (Array<String>)
|
680
|
+
# * :interruption_phrases (Array<String>)
|
622
681
|
# * :monitor_plan (Hash)
|
623
682
|
# * :listen_enabled (Boolean)
|
624
683
|
# * :control_enabled (Boolean)
|
@@ -628,6 +687,11 @@ module Vapi
|
|
628
687
|
# * :url (String)
|
629
688
|
# * :secret (String)
|
630
689
|
# * :headers (Hash{String => Object})
|
690
|
+
# * :backoff_plan (Hash)
|
691
|
+
# * :max_retries (Float)
|
692
|
+
# * :type (Hash{String => Object})
|
693
|
+
# * :base_delay_seconds (Float)
|
694
|
+
# * :hooks (Array<Vapi::AssistantHooks>)
|
631
695
|
# @param assistant_overrides [Hash] These are the overrides for the `assistant` or `assistantId`'s settings and
|
632
696
|
# template variables.Request of type Vapi::AssistantOverrides, as a Hash
|
633
697
|
# * :transcriber (Hash)
|
@@ -635,7 +699,6 @@ module Vapi
|
|
635
699
|
# * :voice (Hash)
|
636
700
|
# * :first_message (String)
|
637
701
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
638
|
-
# * :hipaa_enabled (Boolean)
|
639
702
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
640
703
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
641
704
|
# * :silence_timeout_seconds (Float)
|
@@ -658,6 +721,9 @@ module Vapi
|
|
658
721
|
# * :voicemail_message (String)
|
659
722
|
# * :end_call_message (String)
|
660
723
|
# * :end_call_phrases (Array<String>)
|
724
|
+
# * :compliance_plan (Hash)
|
725
|
+
# * :hipaa_enabled (Boolean)
|
726
|
+
# * :pci_enabled (Boolean)
|
661
727
|
# * :metadata (Hash{String => Object})
|
662
728
|
# * :analysis_plan (Hash)
|
663
729
|
# * :summary_plan (Hash)
|
@@ -673,6 +739,9 @@ module Vapi
|
|
673
739
|
# * :properties (Hash{String => Object})
|
674
740
|
# * :description (String)
|
675
741
|
# * :required (Array<String>)
|
742
|
+
# * :regex (String)
|
743
|
+
# * :value (String)
|
744
|
+
# * :target (String)
|
676
745
|
# * :enum (Array<String>)
|
677
746
|
# * :timeout_seconds (Float)
|
678
747
|
# * :success_evaluation_plan (Hash)
|
@@ -683,6 +752,8 @@ module Vapi
|
|
683
752
|
# * :artifact_plan (Hash)
|
684
753
|
# * :recording_enabled (Boolean)
|
685
754
|
# * :video_recording_enabled (Boolean)
|
755
|
+
# * :pcap_enabled (Boolean)
|
756
|
+
# * :pcap_s_3_path_prefix (String)
|
686
757
|
# * :transcript_plan (Hash)
|
687
758
|
# * :enabled (Boolean)
|
688
759
|
# * :assistant_name (String)
|
@@ -692,6 +763,7 @@ module Vapi
|
|
692
763
|
# * :idle_messages (Array<String>)
|
693
764
|
# * :idle_message_max_spoken_count (Float)
|
694
765
|
# * :idle_timeout_seconds (Float)
|
766
|
+
# * :silence_timeout_message (String)
|
695
767
|
# * :start_speaking_plan (Hash)
|
696
768
|
# * :wait_seconds (Float)
|
697
769
|
# * :smart_endpointing_enabled (Boolean)
|
@@ -704,6 +776,8 @@ module Vapi
|
|
704
776
|
# * :num_words (Float)
|
705
777
|
# * :voice_seconds (Float)
|
706
778
|
# * :backoff_seconds (Float)
|
779
|
+
# * :acknowledgement_phrases (Array<String>)
|
780
|
+
# * :interruption_phrases (Array<String>)
|
707
781
|
# * :monitor_plan (Hash)
|
708
782
|
# * :listen_enabled (Boolean)
|
709
783
|
# * :control_enabled (Boolean)
|
@@ -713,6 +787,11 @@ module Vapi
|
|
713
787
|
# * :url (String)
|
714
788
|
# * :secret (String)
|
715
789
|
# * :headers (Hash{String => Object})
|
790
|
+
# * :backoff_plan (Hash)
|
791
|
+
# * :max_retries (Float)
|
792
|
+
# * :type (Hash{String => Object})
|
793
|
+
# * :base_delay_seconds (Float)
|
794
|
+
# * :hooks (Array<Vapi::AssistantHooks>)
|
716
795
|
# @param squad_id [String] This is the squad that will be used for the call. To use a transient squad, use
|
717
796
|
# `squad` instead.
|
718
797
|
# @param squad [Hash] This is a squad that will be used for the call. To use an existing squad, use
|
@@ -725,7 +804,6 @@ module Vapi
|
|
725
804
|
# * :voice (Hash)
|
726
805
|
# * :first_message (String)
|
727
806
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
728
|
-
# * :hipaa_enabled (Boolean)
|
729
807
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
730
808
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
731
809
|
# * :silence_timeout_seconds (Float)
|
@@ -748,6 +826,9 @@ module Vapi
|
|
748
826
|
# * :voicemail_message (String)
|
749
827
|
# * :end_call_message (String)
|
750
828
|
# * :end_call_phrases (Array<String>)
|
829
|
+
# * :compliance_plan (Hash)
|
830
|
+
# * :hipaa_enabled (Boolean)
|
831
|
+
# * :pci_enabled (Boolean)
|
751
832
|
# * :metadata (Hash{String => Object})
|
752
833
|
# * :analysis_plan (Hash)
|
753
834
|
# * :summary_plan (Hash)
|
@@ -763,6 +844,9 @@ module Vapi
|
|
763
844
|
# * :properties (Hash{String => Object})
|
764
845
|
# * :description (String)
|
765
846
|
# * :required (Array<String>)
|
847
|
+
# * :regex (String)
|
848
|
+
# * :value (String)
|
849
|
+
# * :target (String)
|
766
850
|
# * :enum (Array<String>)
|
767
851
|
# * :timeout_seconds (Float)
|
768
852
|
# * :success_evaluation_plan (Hash)
|
@@ -773,6 +857,8 @@ module Vapi
|
|
773
857
|
# * :artifact_plan (Hash)
|
774
858
|
# * :recording_enabled (Boolean)
|
775
859
|
# * :video_recording_enabled (Boolean)
|
860
|
+
# * :pcap_enabled (Boolean)
|
861
|
+
# * :pcap_s_3_path_prefix (String)
|
776
862
|
# * :transcript_plan (Hash)
|
777
863
|
# * :enabled (Boolean)
|
778
864
|
# * :assistant_name (String)
|
@@ -782,6 +868,7 @@ module Vapi
|
|
782
868
|
# * :idle_messages (Array<String>)
|
783
869
|
# * :idle_message_max_spoken_count (Float)
|
784
870
|
# * :idle_timeout_seconds (Float)
|
871
|
+
# * :silence_timeout_message (String)
|
785
872
|
# * :start_speaking_plan (Hash)
|
786
873
|
# * :wait_seconds (Float)
|
787
874
|
# * :smart_endpointing_enabled (Boolean)
|
@@ -794,6 +881,8 @@ module Vapi
|
|
794
881
|
# * :num_words (Float)
|
795
882
|
# * :voice_seconds (Float)
|
796
883
|
# * :backoff_seconds (Float)
|
884
|
+
# * :acknowledgement_phrases (Array<String>)
|
885
|
+
# * :interruption_phrases (Array<String>)
|
797
886
|
# * :monitor_plan (Hash)
|
798
887
|
# * :listen_enabled (Boolean)
|
799
888
|
# * :control_enabled (Boolean)
|
@@ -803,6 +892,11 @@ module Vapi
|
|
803
892
|
# * :url (String)
|
804
893
|
# * :secret (String)
|
805
894
|
# * :headers (Hash{String => Object})
|
895
|
+
# * :backoff_plan (Hash)
|
896
|
+
# * :max_retries (Float)
|
897
|
+
# * :type (Hash{String => Object})
|
898
|
+
# * :base_delay_seconds (Float)
|
899
|
+
# * :hooks (Array<Vapi::AssistantHooks>)
|
806
900
|
# @param phone_number_id [String] This is the phone number that will be used for the call. To use a transient
|
807
901
|
# number, use `phoneNumber` instead.
|
808
902
|
# Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
|
@@ -821,6 +915,10 @@ module Vapi
|
|
821
915
|
# * :url (String)
|
822
916
|
# * :secret (String)
|
823
917
|
# * :headers (Hash{String => Object})
|
918
|
+
# * :backoff_plan (Hash)
|
919
|
+
# * :max_retries (Float)
|
920
|
+
# * :type (Hash{String => Object})
|
921
|
+
# * :base_delay_seconds (Float)
|
824
922
|
# @param customer_id [String] This is the customer that will be called. To call a transient customer , use
|
825
923
|
# `customer` instead.
|
826
924
|
# Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
|
@@ -27,7 +27,7 @@ module Vapi
|
|
27
27
|
# @param squad_id [String] This is the ID of the squad.
|
28
28
|
# @param call_id [String] This is the ID of the call.
|
29
29
|
# @param page [Float] This is the page number to return. Defaults to 1.
|
30
|
-
# @param sort_order [Vapi::Logs::LogsGetRequestSortOrder] This is the sort order for pagination. Defaults to '
|
30
|
+
# @param sort_order [Vapi::Logs::LogsGetRequestSortOrder] This is the sort order for pagination. Defaults to 'DESC'.
|
31
31
|
# @param limit [Float] This is the maximum number of items to return. Defaults to 100.
|
32
32
|
# @param created_at_gt [DateTime] This will return items where the createdAt is greater than the specified value.
|
33
33
|
# @param created_at_lt [DateTime] This will return items where the createdAt is less than the specified value.
|
@@ -135,7 +135,7 @@ module Vapi
|
|
135
135
|
# @param squad_id [String] This is the ID of the squad.
|
136
136
|
# @param call_id [String] This is the ID of the call.
|
137
137
|
# @param page [Float] This is the page number to return. Defaults to 1.
|
138
|
-
# @param sort_order [Vapi::Logs::LogsGetRequestSortOrder] This is the sort order for pagination. Defaults to '
|
138
|
+
# @param sort_order [Vapi::Logs::LogsGetRequestSortOrder] This is the sort order for pagination. Defaults to 'DESC'.
|
139
139
|
# @param limit [Float] This is the maximum number of items to return. Defaults to 100.
|
140
140
|
# @param created_at_gt [DateTime] This will return items where the createdAt is greater than the specified value.
|
141
141
|
# @param created_at_lt [DateTime] This will return items where the createdAt is less than the specified value.
|