vapi_server_sdk 0.3.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 +83 -12
- data/lib/vapi_server_sdk/analytics/client.rb +41 -26
- data/lib/vapi_server_sdk/assistants/client.rb +84 -84
- data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_server_messages_item.rb +1 -0
- data/lib/vapi_server_sdk/blocks/client.rb +0 -70
- data/lib/vapi_server_sdk/calls/client.rb +110 -76
- data/lib/vapi_server_sdk/files/client.rb +0 -70
- data/lib/vapi_server_sdk/knowledge_bases/client.rb +0 -70
- data/lib/vapi_server_sdk/logs/client.rb +15 -46
- data/lib/vapi_server_sdk/logs/types/logging_controller_logs_delete_query_request_type.rb +12 -0
- data/lib/vapi_server_sdk/phone_numbers/client.rb +0 -70
- data/lib/vapi_server_sdk/squads/client.rb +136 -78
- 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/tools/client.rb +0 -70
- data/lib/vapi_server_sdk/types/ai_edge_condition.rb +55 -0
- 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_credential_region.rb +4 -2
- data/lib/vapi_server_sdk/types/azure_open_ai_credential_models_item.rb +1 -0
- data/lib/vapi_server_sdk/types/azure_open_ai_credential_region.rb +4 -2
- data/lib/vapi_server_sdk/types/backoff_plan.rb +80 -0
- data/lib/vapi_server_sdk/types/bash_tool_with_tool_call.rb +175 -0
- data/lib/vapi_server_sdk/types/bash_tool_with_tool_call_messages_item.rb +120 -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_end_call.rb +47 -0
- data/lib/vapi_server_sdk/types/client_inbound_message_message.rb +13 -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_tool_calls_tool_with_tool_call_list_item.rb +116 -77
- 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/computer_tool_with_tool_call.rb +199 -0
- data/lib/vapi_server_sdk/types/computer_tool_with_tool_call_messages_item.rb +120 -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_credential_dto_region.rb +4 -2
- data/lib/vapi_server_sdk/types/create_azure_open_ai_credential_dto_models_item.rb +1 -0
- data/lib/vapi_server_sdk/types/create_azure_open_ai_credential_dto_region.rb +4 -2
- data/lib/vapi_server_sdk/types/create_custom_knowledge_base_dto.rb +2 -4
- data/lib/vapi_server_sdk/types/create_test_suite_test_voice_dto.rb +90 -0
- data/lib/vapi_server_sdk/types/create_trieve_knowledge_base_dto.rb +34 -47
- data/lib/vapi_server_sdk/types/create_trieve_knowledge_base_dto_create_plan.rb +97 -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 +80 -0
- data/lib/vapi_server_sdk/types/create_workflow_dto_nodes_item.rb +133 -0
- data/lib/vapi_server_sdk/types/custom_knowledge_base.rb +2 -4
- 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 +87 -0
- data/lib/vapi_server_sdk/types/edge_condition.rb +107 -0
- 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/function_tool_with_tool_call.rb +1 -10
- data/lib/vapi_server_sdk/types/gather.rb +143 -0
- data/lib/vapi_server_sdk/types/ghl_tool_with_tool_call.rb +1 -9
- 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 +37 -2
- data/lib/vapi_server_sdk/types/log.rb +18 -18
- data/lib/vapi_server_sdk/types/logic_edge_condition.rb +55 -0
- data/lib/vapi_server_sdk/types/make_tool_with_tool_call.rb +1 -9
- 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 +81 -0
- 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_tool_calls_tool_with_tool_call_list_item.rb +116 -77
- 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 +44 -14
- 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/text_editor_tool_with_tool_call.rb +175 -0
- data/lib/vapi_server_sdk/types/text_editor_tool_with_tool_call_messages_item.rb +121 -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.rb +35 -44
- data/lib/vapi_server_sdk/types/{trieve_knowledge_base_vector_store_create_plan.rb → trieve_knowledge_base_chunk_plan.rb} +17 -11
- data/lib/vapi_server_sdk/types/trieve_knowledge_base_create.rb +59 -0
- data/lib/vapi_server_sdk/types/trieve_knowledge_base_create_plan.rb +96 -0
- data/lib/vapi_server_sdk/types/trieve_knowledge_base_import.rb +55 -0
- data/lib/vapi_server_sdk/types/{trieve_knowledge_base_vector_store_search_plan.rb → trieve_knowledge_base_search_plan.rb} +21 -12
- data/lib/vapi_server_sdk/types/{trieve_knowledge_base_vector_store_search_plan_search_type.rb → trieve_knowledge_base_search_plan_search_type.rb} +1 -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_credential_dto_region.rb +4 -2
- data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto_models_item.rb +1 -0
- data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto_region.rb +4 -2
- data/lib/vapi_server_sdk/types/update_custom_knowledge_base_dto.rb +2 -4
- data/lib/vapi_server_sdk/types/update_test_suite_test_voice_dto.rb +90 -0
- data/lib/vapi_server_sdk/types/update_trieve_knowledge_base_dto.rb +34 -47
- data/lib/vapi_server_sdk/types/update_trieve_knowledge_base_dto_create_plan.rb +97 -0
- data/lib/vapi_server_sdk/types/vapi_model.rb +27 -1
- 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 +117 -0
- data/lib/vapi_server_sdk/types/workflow_nodes_item.rb +133 -0
- 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 +85 -11
- 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
@@ -35,13 +35,6 @@ module Vapi
|
|
35
35
|
# specified value.
|
36
36
|
# @param request_options [Vapi::RequestOptions]
|
37
37
|
# @return [Array<Vapi::Squad>]
|
38
|
-
# @example
|
39
|
-
# api = Vapi::Client.new(
|
40
|
-
# base_url: "https://api.example.com",
|
41
|
-
# environment: Vapi::Environment::DEFAULT,
|
42
|
-
# token: "YOUR_AUTH_TOKEN"
|
43
|
-
# )
|
44
|
-
# api.squads.list
|
45
38
|
def list(limit: nil, created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil,
|
46
39
|
updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
|
47
40
|
response = @request_client.conn.get do |req|
|
@@ -85,7 +78,6 @@ module Vapi
|
|
85
78
|
# * :voice (Hash)
|
86
79
|
# * :first_message (String)
|
87
80
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
88
|
-
# * :hipaa_enabled (Boolean)
|
89
81
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
90
82
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
91
83
|
# * :silence_timeout_seconds (Float)
|
@@ -108,6 +100,9 @@ module Vapi
|
|
108
100
|
# * :voicemail_message (String)
|
109
101
|
# * :end_call_message (String)
|
110
102
|
# * :end_call_phrases (Array<String>)
|
103
|
+
# * :compliance_plan (Hash)
|
104
|
+
# * :hipaa_enabled (Boolean)
|
105
|
+
# * :pci_enabled (Boolean)
|
111
106
|
# * :metadata (Hash{String => Object})
|
112
107
|
# * :analysis_plan (Hash)
|
113
108
|
# * :summary_plan (Hash)
|
@@ -123,6 +118,10 @@ module Vapi
|
|
123
118
|
# * :properties (Hash{String => Object})
|
124
119
|
# * :description (String)
|
125
120
|
# * :required (Array<String>)
|
121
|
+
# * :regex (String)
|
122
|
+
# * :value (String)
|
123
|
+
# * :target (String)
|
124
|
+
# * :enum (Array<String>)
|
126
125
|
# * :timeout_seconds (Float)
|
127
126
|
# * :success_evaluation_plan (Hash)
|
128
127
|
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
@@ -132,6 +131,8 @@ module Vapi
|
|
132
131
|
# * :artifact_plan (Hash)
|
133
132
|
# * :recording_enabled (Boolean)
|
134
133
|
# * :video_recording_enabled (Boolean)
|
134
|
+
# * :pcap_enabled (Boolean)
|
135
|
+
# * :pcap_s_3_path_prefix (String)
|
135
136
|
# * :transcript_plan (Hash)
|
136
137
|
# * :enabled (Boolean)
|
137
138
|
# * :assistant_name (String)
|
@@ -141,6 +142,7 @@ module Vapi
|
|
141
142
|
# * :idle_messages (Array<String>)
|
142
143
|
# * :idle_message_max_spoken_count (Float)
|
143
144
|
# * :idle_timeout_seconds (Float)
|
145
|
+
# * :silence_timeout_message (String)
|
144
146
|
# * :start_speaking_plan (Hash)
|
145
147
|
# * :wait_seconds (Float)
|
146
148
|
# * :smart_endpointing_enabled (Boolean)
|
@@ -153,6 +155,8 @@ module Vapi
|
|
153
155
|
# * :num_words (Float)
|
154
156
|
# * :voice_seconds (Float)
|
155
157
|
# * :backoff_seconds (Float)
|
158
|
+
# * :acknowledgement_phrases (Array<String>)
|
159
|
+
# * :interruption_phrases (Array<String>)
|
156
160
|
# * :monitor_plan (Hash)
|
157
161
|
# * :listen_enabled (Boolean)
|
158
162
|
# * :control_enabled (Boolean)
|
@@ -162,15 +166,13 @@ module Vapi
|
|
162
166
|
# * :url (String)
|
163
167
|
# * :secret (String)
|
164
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>)
|
165
174
|
# @param request_options [Vapi::RequestOptions]
|
166
175
|
# @return [Vapi::Squad]
|
167
|
-
# @example
|
168
|
-
# api = Vapi::Client.new(
|
169
|
-
# base_url: "https://api.example.com",
|
170
|
-
# environment: Vapi::Environment::DEFAULT,
|
171
|
-
# token: "YOUR_AUTH_TOKEN"
|
172
|
-
# )
|
173
|
-
# api.squads.create(request: { members: [{ }] })
|
174
176
|
def create(request:, request_options: nil)
|
175
177
|
response = @request_client.conn.post do |req|
|
176
178
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
@@ -192,13 +194,6 @@ module Vapi
|
|
192
194
|
# @param id [String]
|
193
195
|
# @param request_options [Vapi::RequestOptions]
|
194
196
|
# @return [Vapi::Squad]
|
195
|
-
# @example
|
196
|
-
# api = Vapi::Client.new(
|
197
|
-
# base_url: "https://api.example.com",
|
198
|
-
# environment: Vapi::Environment::DEFAULT,
|
199
|
-
# token: "YOUR_AUTH_TOKEN"
|
200
|
-
# )
|
201
|
-
# api.squads.get(id: "id")
|
202
197
|
def get(id:, request_options: nil)
|
203
198
|
response = @request_client.conn.get do |req|
|
204
199
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
@@ -222,13 +217,6 @@ module Vapi
|
|
222
217
|
# @param id [String]
|
223
218
|
# @param request_options [Vapi::RequestOptions]
|
224
219
|
# @return [Vapi::Squad]
|
225
|
-
# @example
|
226
|
-
# api = Vapi::Client.new(
|
227
|
-
# base_url: "https://api.example.com",
|
228
|
-
# environment: Vapi::Environment::DEFAULT,
|
229
|
-
# token: "YOUR_AUTH_TOKEN"
|
230
|
-
# )
|
231
|
-
# api.squads.delete(id: "id")
|
232
220
|
def delete(id:, request_options: nil)
|
233
221
|
response = @request_client.conn.delete do |req|
|
234
222
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
@@ -260,7 +248,6 @@ module Vapi
|
|
260
248
|
# * :voice (Hash)
|
261
249
|
# * :first_message (String)
|
262
250
|
# * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
|
263
|
-
# * :hipaa_enabled (Boolean)
|
264
251
|
# * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
|
265
252
|
# * :server_messages (Array<Vapi::CreateAssistantDtoServerMessagesItem>)
|
266
253
|
# * :silence_timeout_seconds (Float)
|
@@ -282,6 +269,9 @@ module Vapi
|
|
282
269
|
# * :voicemail_message (String)
|
283
270
|
# * :end_call_message (String)
|
284
271
|
# * :end_call_phrases (Array<String>)
|
272
|
+
# * :compliance_plan (Hash)
|
273
|
+
# * :hipaa_enabled (Boolean)
|
274
|
+
# * :pci_enabled (Boolean)
|
285
275
|
# * :metadata (Hash{String => Object})
|
286
276
|
# * :analysis_plan (Hash)
|
287
277
|
# * :summary_plan (Hash)
|
@@ -297,6 +287,10 @@ module Vapi
|
|
297
287
|
# * :properties (Hash{String => Object})
|
298
288
|
# * :description (String)
|
299
289
|
# * :required (Array<String>)
|
290
|
+
# * :regex (String)
|
291
|
+
# * :value (String)
|
292
|
+
# * :target (String)
|
293
|
+
# * :enum (Array<String>)
|
300
294
|
# * :timeout_seconds (Float)
|
301
295
|
# * :success_evaluation_plan (Hash)
|
302
296
|
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
@@ -306,6 +300,8 @@ module Vapi
|
|
306
300
|
# * :artifact_plan (Hash)
|
307
301
|
# * :recording_enabled (Boolean)
|
308
302
|
# * :video_recording_enabled (Boolean)
|
303
|
+
# * :pcap_enabled (Boolean)
|
304
|
+
# * :pcap_s_3_path_prefix (String)
|
309
305
|
# * :transcript_plan (Hash)
|
310
306
|
# * :enabled (Boolean)
|
311
307
|
# * :assistant_name (String)
|
@@ -315,6 +311,7 @@ module Vapi
|
|
315
311
|
# * :idle_messages (Array<String>)
|
316
312
|
# * :idle_message_max_spoken_count (Float)
|
317
313
|
# * :idle_timeout_seconds (Float)
|
314
|
+
# * :silence_timeout_message (String)
|
318
315
|
# * :start_speaking_plan (Hash)
|
319
316
|
# * :wait_seconds (Float)
|
320
317
|
# * :smart_endpointing_enabled (Boolean)
|
@@ -327,6 +324,8 @@ module Vapi
|
|
327
324
|
# * :num_words (Float)
|
328
325
|
# * :voice_seconds (Float)
|
329
326
|
# * :backoff_seconds (Float)
|
327
|
+
# * :acknowledgement_phrases (Array<String>)
|
328
|
+
# * :interruption_phrases (Array<String>)
|
330
329
|
# * :monitor_plan (Hash)
|
331
330
|
# * :listen_enabled (Boolean)
|
332
331
|
# * :control_enabled (Boolean)
|
@@ -336,13 +335,17 @@ module Vapi
|
|
336
335
|
# * :url (String)
|
337
336
|
# * :secret (String)
|
338
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>)
|
339
343
|
# * :assistant_overrides (Hash)
|
340
344
|
# * :transcriber (Hash)
|
341
345
|
# * :model (Hash)
|
342
346
|
# * :voice (Hash)
|
343
347
|
# * :first_message (String)
|
344
348
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
345
|
-
# * :hipaa_enabled (Boolean)
|
346
349
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
347
350
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
348
351
|
# * :silence_timeout_seconds (Float)
|
@@ -365,6 +368,9 @@ module Vapi
|
|
365
368
|
# * :voicemail_message (String)
|
366
369
|
# * :end_call_message (String)
|
367
370
|
# * :end_call_phrases (Array<String>)
|
371
|
+
# * :compliance_plan (Hash)
|
372
|
+
# * :hipaa_enabled (Boolean)
|
373
|
+
# * :pci_enabled (Boolean)
|
368
374
|
# * :metadata (Hash{String => Object})
|
369
375
|
# * :analysis_plan (Hash)
|
370
376
|
# * :summary_plan (Hash)
|
@@ -380,6 +386,10 @@ module Vapi
|
|
380
386
|
# * :properties (Hash{String => Object})
|
381
387
|
# * :description (String)
|
382
388
|
# * :required (Array<String>)
|
389
|
+
# * :regex (String)
|
390
|
+
# * :value (String)
|
391
|
+
# * :target (String)
|
392
|
+
# * :enum (Array<String>)
|
383
393
|
# * :timeout_seconds (Float)
|
384
394
|
# * :success_evaluation_plan (Hash)
|
385
395
|
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
@@ -389,6 +399,8 @@ module Vapi
|
|
389
399
|
# * :artifact_plan (Hash)
|
390
400
|
# * :recording_enabled (Boolean)
|
391
401
|
# * :video_recording_enabled (Boolean)
|
402
|
+
# * :pcap_enabled (Boolean)
|
403
|
+
# * :pcap_s_3_path_prefix (String)
|
392
404
|
# * :transcript_plan (Hash)
|
393
405
|
# * :enabled (Boolean)
|
394
406
|
# * :assistant_name (String)
|
@@ -398,6 +410,7 @@ module Vapi
|
|
398
410
|
# * :idle_messages (Array<String>)
|
399
411
|
# * :idle_message_max_spoken_count (Float)
|
400
412
|
# * :idle_timeout_seconds (Float)
|
413
|
+
# * :silence_timeout_message (String)
|
401
414
|
# * :start_speaking_plan (Hash)
|
402
415
|
# * :wait_seconds (Float)
|
403
416
|
# * :smart_endpointing_enabled (Boolean)
|
@@ -410,6 +423,8 @@ module Vapi
|
|
410
423
|
# * :num_words (Float)
|
411
424
|
# * :voice_seconds (Float)
|
412
425
|
# * :backoff_seconds (Float)
|
426
|
+
# * :acknowledgement_phrases (Array<String>)
|
427
|
+
# * :interruption_phrases (Array<String>)
|
413
428
|
# * :monitor_plan (Hash)
|
414
429
|
# * :listen_enabled (Boolean)
|
415
430
|
# * :control_enabled (Boolean)
|
@@ -419,6 +434,11 @@ module Vapi
|
|
419
434
|
# * :url (String)
|
420
435
|
# * :secret (String)
|
421
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>)
|
422
442
|
# * :assistant_destinations (Array<Vapi::TransferDestinationAssistant>)
|
423
443
|
# @param members_overrides [Hash] This can be used to override all the assistants' settings and provide values for
|
424
444
|
# their template variables.
|
@@ -430,7 +450,6 @@ module Vapi
|
|
430
450
|
# * :voice (Hash)
|
431
451
|
# * :first_message (String)
|
432
452
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
433
|
-
# * :hipaa_enabled (Boolean)
|
434
453
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
435
454
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
436
455
|
# * :silence_timeout_seconds (Float)
|
@@ -453,6 +472,9 @@ module Vapi
|
|
453
472
|
# * :voicemail_message (String)
|
454
473
|
# * :end_call_message (String)
|
455
474
|
# * :end_call_phrases (Array<String>)
|
475
|
+
# * :compliance_plan (Hash)
|
476
|
+
# * :hipaa_enabled (Boolean)
|
477
|
+
# * :pci_enabled (Boolean)
|
456
478
|
# * :metadata (Hash{String => Object})
|
457
479
|
# * :analysis_plan (Hash)
|
458
480
|
# * :summary_plan (Hash)
|
@@ -468,6 +490,10 @@ module Vapi
|
|
468
490
|
# * :properties (Hash{String => Object})
|
469
491
|
# * :description (String)
|
470
492
|
# * :required (Array<String>)
|
493
|
+
# * :regex (String)
|
494
|
+
# * :value (String)
|
495
|
+
# * :target (String)
|
496
|
+
# * :enum (Array<String>)
|
471
497
|
# * :timeout_seconds (Float)
|
472
498
|
# * :success_evaluation_plan (Hash)
|
473
499
|
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
@@ -477,6 +503,8 @@ module Vapi
|
|
477
503
|
# * :artifact_plan (Hash)
|
478
504
|
# * :recording_enabled (Boolean)
|
479
505
|
# * :video_recording_enabled (Boolean)
|
506
|
+
# * :pcap_enabled (Boolean)
|
507
|
+
# * :pcap_s_3_path_prefix (String)
|
480
508
|
# * :transcript_plan (Hash)
|
481
509
|
# * :enabled (Boolean)
|
482
510
|
# * :assistant_name (String)
|
@@ -486,6 +514,7 @@ module Vapi
|
|
486
514
|
# * :idle_messages (Array<String>)
|
487
515
|
# * :idle_message_max_spoken_count (Float)
|
488
516
|
# * :idle_timeout_seconds (Float)
|
517
|
+
# * :silence_timeout_message (String)
|
489
518
|
# * :start_speaking_plan (Hash)
|
490
519
|
# * :wait_seconds (Float)
|
491
520
|
# * :smart_endpointing_enabled (Boolean)
|
@@ -498,6 +527,8 @@ module Vapi
|
|
498
527
|
# * :num_words (Float)
|
499
528
|
# * :voice_seconds (Float)
|
500
529
|
# * :backoff_seconds (Float)
|
530
|
+
# * :acknowledgement_phrases (Array<String>)
|
531
|
+
# * :interruption_phrases (Array<String>)
|
501
532
|
# * :monitor_plan (Hash)
|
502
533
|
# * :listen_enabled (Boolean)
|
503
534
|
# * :control_enabled (Boolean)
|
@@ -507,15 +538,13 @@ module Vapi
|
|
507
538
|
# * :url (String)
|
508
539
|
# * :secret (String)
|
509
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>)
|
510
546
|
# @param request_options [Vapi::RequestOptions]
|
511
547
|
# @return [Vapi::Squad]
|
512
|
-
# @example
|
513
|
-
# api = Vapi::Client.new(
|
514
|
-
# base_url: "https://api.example.com",
|
515
|
-
# environment: Vapi::Environment::DEFAULT,
|
516
|
-
# token: "YOUR_AUTH_TOKEN"
|
517
|
-
# )
|
518
|
-
# api.squads.update(id: "id", members: [{ }])
|
519
548
|
def update(id:, members:, name: nil, members_overrides: nil, request_options: nil)
|
520
549
|
response = @request_client.conn.patch do |req|
|
521
550
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
@@ -565,13 +594,6 @@ module Vapi
|
|
565
594
|
# specified value.
|
566
595
|
# @param request_options [Vapi::RequestOptions]
|
567
596
|
# @return [Array<Vapi::Squad>]
|
568
|
-
# @example
|
569
|
-
# api = Vapi::Client.new(
|
570
|
-
# base_url: "https://api.example.com",
|
571
|
-
# environment: Vapi::Environment::DEFAULT,
|
572
|
-
# token: "YOUR_AUTH_TOKEN"
|
573
|
-
# )
|
574
|
-
# api.squads.list
|
575
597
|
def list(limit: nil, created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil,
|
576
598
|
updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
|
577
599
|
Async do
|
@@ -617,7 +639,6 @@ module Vapi
|
|
617
639
|
# * :voice (Hash)
|
618
640
|
# * :first_message (String)
|
619
641
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
620
|
-
# * :hipaa_enabled (Boolean)
|
621
642
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
622
643
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
623
644
|
# * :silence_timeout_seconds (Float)
|
@@ -640,6 +661,9 @@ module Vapi
|
|
640
661
|
# * :voicemail_message (String)
|
641
662
|
# * :end_call_message (String)
|
642
663
|
# * :end_call_phrases (Array<String>)
|
664
|
+
# * :compliance_plan (Hash)
|
665
|
+
# * :hipaa_enabled (Boolean)
|
666
|
+
# * :pci_enabled (Boolean)
|
643
667
|
# * :metadata (Hash{String => Object})
|
644
668
|
# * :analysis_plan (Hash)
|
645
669
|
# * :summary_plan (Hash)
|
@@ -655,6 +679,10 @@ module Vapi
|
|
655
679
|
# * :properties (Hash{String => Object})
|
656
680
|
# * :description (String)
|
657
681
|
# * :required (Array<String>)
|
682
|
+
# * :regex (String)
|
683
|
+
# * :value (String)
|
684
|
+
# * :target (String)
|
685
|
+
# * :enum (Array<String>)
|
658
686
|
# * :timeout_seconds (Float)
|
659
687
|
# * :success_evaluation_plan (Hash)
|
660
688
|
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
@@ -664,6 +692,8 @@ module Vapi
|
|
664
692
|
# * :artifact_plan (Hash)
|
665
693
|
# * :recording_enabled (Boolean)
|
666
694
|
# * :video_recording_enabled (Boolean)
|
695
|
+
# * :pcap_enabled (Boolean)
|
696
|
+
# * :pcap_s_3_path_prefix (String)
|
667
697
|
# * :transcript_plan (Hash)
|
668
698
|
# * :enabled (Boolean)
|
669
699
|
# * :assistant_name (String)
|
@@ -673,6 +703,7 @@ module Vapi
|
|
673
703
|
# * :idle_messages (Array<String>)
|
674
704
|
# * :idle_message_max_spoken_count (Float)
|
675
705
|
# * :idle_timeout_seconds (Float)
|
706
|
+
# * :silence_timeout_message (String)
|
676
707
|
# * :start_speaking_plan (Hash)
|
677
708
|
# * :wait_seconds (Float)
|
678
709
|
# * :smart_endpointing_enabled (Boolean)
|
@@ -685,6 +716,8 @@ module Vapi
|
|
685
716
|
# * :num_words (Float)
|
686
717
|
# * :voice_seconds (Float)
|
687
718
|
# * :backoff_seconds (Float)
|
719
|
+
# * :acknowledgement_phrases (Array<String>)
|
720
|
+
# * :interruption_phrases (Array<String>)
|
688
721
|
# * :monitor_plan (Hash)
|
689
722
|
# * :listen_enabled (Boolean)
|
690
723
|
# * :control_enabled (Boolean)
|
@@ -694,15 +727,13 @@ module Vapi
|
|
694
727
|
# * :url (String)
|
695
728
|
# * :secret (String)
|
696
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>)
|
697
735
|
# @param request_options [Vapi::RequestOptions]
|
698
736
|
# @return [Vapi::Squad]
|
699
|
-
# @example
|
700
|
-
# api = Vapi::Client.new(
|
701
|
-
# base_url: "https://api.example.com",
|
702
|
-
# environment: Vapi::Environment::DEFAULT,
|
703
|
-
# token: "YOUR_AUTH_TOKEN"
|
704
|
-
# )
|
705
|
-
# api.squads.create(request: { members: [{ }] })
|
706
737
|
def create(request:, request_options: nil)
|
707
738
|
Async do
|
708
739
|
response = @request_client.conn.post do |req|
|
@@ -726,13 +757,6 @@ module Vapi
|
|
726
757
|
# @param id [String]
|
727
758
|
# @param request_options [Vapi::RequestOptions]
|
728
759
|
# @return [Vapi::Squad]
|
729
|
-
# @example
|
730
|
-
# api = Vapi::Client.new(
|
731
|
-
# base_url: "https://api.example.com",
|
732
|
-
# environment: Vapi::Environment::DEFAULT,
|
733
|
-
# token: "YOUR_AUTH_TOKEN"
|
734
|
-
# )
|
735
|
-
# api.squads.get(id: "id")
|
736
760
|
def get(id:, request_options: nil)
|
737
761
|
Async do
|
738
762
|
response = @request_client.conn.get do |req|
|
@@ -758,13 +782,6 @@ module Vapi
|
|
758
782
|
# @param id [String]
|
759
783
|
# @param request_options [Vapi::RequestOptions]
|
760
784
|
# @return [Vapi::Squad]
|
761
|
-
# @example
|
762
|
-
# api = Vapi::Client.new(
|
763
|
-
# base_url: "https://api.example.com",
|
764
|
-
# environment: Vapi::Environment::DEFAULT,
|
765
|
-
# token: "YOUR_AUTH_TOKEN"
|
766
|
-
# )
|
767
|
-
# api.squads.delete(id: "id")
|
768
785
|
def delete(id:, request_options: nil)
|
769
786
|
Async do
|
770
787
|
response = @request_client.conn.delete do |req|
|
@@ -798,7 +815,6 @@ module Vapi
|
|
798
815
|
# * :voice (Hash)
|
799
816
|
# * :first_message (String)
|
800
817
|
# * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
|
801
|
-
# * :hipaa_enabled (Boolean)
|
802
818
|
# * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
|
803
819
|
# * :server_messages (Array<Vapi::CreateAssistantDtoServerMessagesItem>)
|
804
820
|
# * :silence_timeout_seconds (Float)
|
@@ -820,6 +836,9 @@ module Vapi
|
|
820
836
|
# * :voicemail_message (String)
|
821
837
|
# * :end_call_message (String)
|
822
838
|
# * :end_call_phrases (Array<String>)
|
839
|
+
# * :compliance_plan (Hash)
|
840
|
+
# * :hipaa_enabled (Boolean)
|
841
|
+
# * :pci_enabled (Boolean)
|
823
842
|
# * :metadata (Hash{String => Object})
|
824
843
|
# * :analysis_plan (Hash)
|
825
844
|
# * :summary_plan (Hash)
|
@@ -835,6 +854,10 @@ module Vapi
|
|
835
854
|
# * :properties (Hash{String => Object})
|
836
855
|
# * :description (String)
|
837
856
|
# * :required (Array<String>)
|
857
|
+
# * :regex (String)
|
858
|
+
# * :value (String)
|
859
|
+
# * :target (String)
|
860
|
+
# * :enum (Array<String>)
|
838
861
|
# * :timeout_seconds (Float)
|
839
862
|
# * :success_evaluation_plan (Hash)
|
840
863
|
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
@@ -844,6 +867,8 @@ module Vapi
|
|
844
867
|
# * :artifact_plan (Hash)
|
845
868
|
# * :recording_enabled (Boolean)
|
846
869
|
# * :video_recording_enabled (Boolean)
|
870
|
+
# * :pcap_enabled (Boolean)
|
871
|
+
# * :pcap_s_3_path_prefix (String)
|
847
872
|
# * :transcript_plan (Hash)
|
848
873
|
# * :enabled (Boolean)
|
849
874
|
# * :assistant_name (String)
|
@@ -853,6 +878,7 @@ module Vapi
|
|
853
878
|
# * :idle_messages (Array<String>)
|
854
879
|
# * :idle_message_max_spoken_count (Float)
|
855
880
|
# * :idle_timeout_seconds (Float)
|
881
|
+
# * :silence_timeout_message (String)
|
856
882
|
# * :start_speaking_plan (Hash)
|
857
883
|
# * :wait_seconds (Float)
|
858
884
|
# * :smart_endpointing_enabled (Boolean)
|
@@ -865,6 +891,8 @@ module Vapi
|
|
865
891
|
# * :num_words (Float)
|
866
892
|
# * :voice_seconds (Float)
|
867
893
|
# * :backoff_seconds (Float)
|
894
|
+
# * :acknowledgement_phrases (Array<String>)
|
895
|
+
# * :interruption_phrases (Array<String>)
|
868
896
|
# * :monitor_plan (Hash)
|
869
897
|
# * :listen_enabled (Boolean)
|
870
898
|
# * :control_enabled (Boolean)
|
@@ -874,13 +902,17 @@ module Vapi
|
|
874
902
|
# * :url (String)
|
875
903
|
# * :secret (String)
|
876
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>)
|
877
910
|
# * :assistant_overrides (Hash)
|
878
911
|
# * :transcriber (Hash)
|
879
912
|
# * :model (Hash)
|
880
913
|
# * :voice (Hash)
|
881
914
|
# * :first_message (String)
|
882
915
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
883
|
-
# * :hipaa_enabled (Boolean)
|
884
916
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
885
917
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
886
918
|
# * :silence_timeout_seconds (Float)
|
@@ -903,6 +935,9 @@ module Vapi
|
|
903
935
|
# * :voicemail_message (String)
|
904
936
|
# * :end_call_message (String)
|
905
937
|
# * :end_call_phrases (Array<String>)
|
938
|
+
# * :compliance_plan (Hash)
|
939
|
+
# * :hipaa_enabled (Boolean)
|
940
|
+
# * :pci_enabled (Boolean)
|
906
941
|
# * :metadata (Hash{String => Object})
|
907
942
|
# * :analysis_plan (Hash)
|
908
943
|
# * :summary_plan (Hash)
|
@@ -918,6 +953,10 @@ module Vapi
|
|
918
953
|
# * :properties (Hash{String => Object})
|
919
954
|
# * :description (String)
|
920
955
|
# * :required (Array<String>)
|
956
|
+
# * :regex (String)
|
957
|
+
# * :value (String)
|
958
|
+
# * :target (String)
|
959
|
+
# * :enum (Array<String>)
|
921
960
|
# * :timeout_seconds (Float)
|
922
961
|
# * :success_evaluation_plan (Hash)
|
923
962
|
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
@@ -927,6 +966,8 @@ module Vapi
|
|
927
966
|
# * :artifact_plan (Hash)
|
928
967
|
# * :recording_enabled (Boolean)
|
929
968
|
# * :video_recording_enabled (Boolean)
|
969
|
+
# * :pcap_enabled (Boolean)
|
970
|
+
# * :pcap_s_3_path_prefix (String)
|
930
971
|
# * :transcript_plan (Hash)
|
931
972
|
# * :enabled (Boolean)
|
932
973
|
# * :assistant_name (String)
|
@@ -936,6 +977,7 @@ module Vapi
|
|
936
977
|
# * :idle_messages (Array<String>)
|
937
978
|
# * :idle_message_max_spoken_count (Float)
|
938
979
|
# * :idle_timeout_seconds (Float)
|
980
|
+
# * :silence_timeout_message (String)
|
939
981
|
# * :start_speaking_plan (Hash)
|
940
982
|
# * :wait_seconds (Float)
|
941
983
|
# * :smart_endpointing_enabled (Boolean)
|
@@ -948,6 +990,8 @@ module Vapi
|
|
948
990
|
# * :num_words (Float)
|
949
991
|
# * :voice_seconds (Float)
|
950
992
|
# * :backoff_seconds (Float)
|
993
|
+
# * :acknowledgement_phrases (Array<String>)
|
994
|
+
# * :interruption_phrases (Array<String>)
|
951
995
|
# * :monitor_plan (Hash)
|
952
996
|
# * :listen_enabled (Boolean)
|
953
997
|
# * :control_enabled (Boolean)
|
@@ -957,6 +1001,11 @@ module Vapi
|
|
957
1001
|
# * :url (String)
|
958
1002
|
# * :secret (String)
|
959
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>)
|
960
1009
|
# * :assistant_destinations (Array<Vapi::TransferDestinationAssistant>)
|
961
1010
|
# @param members_overrides [Hash] This can be used to override all the assistants' settings and provide values for
|
962
1011
|
# their template variables.
|
@@ -968,7 +1017,6 @@ module Vapi
|
|
968
1017
|
# * :voice (Hash)
|
969
1018
|
# * :first_message (String)
|
970
1019
|
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
971
|
-
# * :hipaa_enabled (Boolean)
|
972
1020
|
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
973
1021
|
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
974
1022
|
# * :silence_timeout_seconds (Float)
|
@@ -991,6 +1039,9 @@ module Vapi
|
|
991
1039
|
# * :voicemail_message (String)
|
992
1040
|
# * :end_call_message (String)
|
993
1041
|
# * :end_call_phrases (Array<String>)
|
1042
|
+
# * :compliance_plan (Hash)
|
1043
|
+
# * :hipaa_enabled (Boolean)
|
1044
|
+
# * :pci_enabled (Boolean)
|
994
1045
|
# * :metadata (Hash{String => Object})
|
995
1046
|
# * :analysis_plan (Hash)
|
996
1047
|
# * :summary_plan (Hash)
|
@@ -1006,6 +1057,10 @@ module Vapi
|
|
1006
1057
|
# * :properties (Hash{String => Object})
|
1007
1058
|
# * :description (String)
|
1008
1059
|
# * :required (Array<String>)
|
1060
|
+
# * :regex (String)
|
1061
|
+
# * :value (String)
|
1062
|
+
# * :target (String)
|
1063
|
+
# * :enum (Array<String>)
|
1009
1064
|
# * :timeout_seconds (Float)
|
1010
1065
|
# * :success_evaluation_plan (Hash)
|
1011
1066
|
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
@@ -1015,6 +1070,8 @@ module Vapi
|
|
1015
1070
|
# * :artifact_plan (Hash)
|
1016
1071
|
# * :recording_enabled (Boolean)
|
1017
1072
|
# * :video_recording_enabled (Boolean)
|
1073
|
+
# * :pcap_enabled (Boolean)
|
1074
|
+
# * :pcap_s_3_path_prefix (String)
|
1018
1075
|
# * :transcript_plan (Hash)
|
1019
1076
|
# * :enabled (Boolean)
|
1020
1077
|
# * :assistant_name (String)
|
@@ -1024,6 +1081,7 @@ module Vapi
|
|
1024
1081
|
# * :idle_messages (Array<String>)
|
1025
1082
|
# * :idle_message_max_spoken_count (Float)
|
1026
1083
|
# * :idle_timeout_seconds (Float)
|
1084
|
+
# * :silence_timeout_message (String)
|
1027
1085
|
# * :start_speaking_plan (Hash)
|
1028
1086
|
# * :wait_seconds (Float)
|
1029
1087
|
# * :smart_endpointing_enabled (Boolean)
|
@@ -1036,6 +1094,8 @@ module Vapi
|
|
1036
1094
|
# * :num_words (Float)
|
1037
1095
|
# * :voice_seconds (Float)
|
1038
1096
|
# * :backoff_seconds (Float)
|
1097
|
+
# * :acknowledgement_phrases (Array<String>)
|
1098
|
+
# * :interruption_phrases (Array<String>)
|
1039
1099
|
# * :monitor_plan (Hash)
|
1040
1100
|
# * :listen_enabled (Boolean)
|
1041
1101
|
# * :control_enabled (Boolean)
|
@@ -1045,15 +1105,13 @@ module Vapi
|
|
1045
1105
|
# * :url (String)
|
1046
1106
|
# * :secret (String)
|
1047
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>)
|
1048
1113
|
# @param request_options [Vapi::RequestOptions]
|
1049
1114
|
# @return [Vapi::Squad]
|
1050
|
-
# @example
|
1051
|
-
# api = Vapi::Client.new(
|
1052
|
-
# base_url: "https://api.example.com",
|
1053
|
-
# environment: Vapi::Environment::DEFAULT,
|
1054
|
-
# token: "YOUR_AUTH_TOKEN"
|
1055
|
-
# )
|
1056
|
-
# api.squads.update(id: "id", members: [{ }])
|
1057
1115
|
def update(id:, members:, name: nil, members_overrides: nil, request_options: nil)
|
1058
1116
|
Async do
|
1059
1117
|
response = @request_client.conn.patch do |req|
|