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
@@ -10,6 +10,7 @@ require_relative "assistant_background_sound"
|
|
10
10
|
require_relative "transport_configuration_twilio"
|
11
11
|
require_relative "assistant_credentials_item"
|
12
12
|
require_relative "twilio_voicemail_detection"
|
13
|
+
require_relative "compliance_plan"
|
13
14
|
require_relative "analysis_plan"
|
14
15
|
require_relative "artifact_plan"
|
15
16
|
require_relative "message_plan"
|
@@ -17,6 +18,7 @@ require_relative "start_speaking_plan"
|
|
17
18
|
require_relative "stop_speaking_plan"
|
18
19
|
require_relative "monitor_plan"
|
19
20
|
require_relative "server"
|
21
|
+
require_relative "assistant_hooks"
|
20
22
|
require "date"
|
21
23
|
require "ostruct"
|
22
24
|
require "json"
|
@@ -45,10 +47,6 @@ module Vapi
|
|
45
47
|
# transfer points).
|
46
48
|
# @default 'assistant-speaks-first'
|
47
49
|
attr_reader :first_message_mode
|
48
|
-
# @return [Boolean] When this is enabled, no logs, recordings, or transcriptions will be stored. At
|
49
|
-
# the end of the call, you will still receive an end-of-call-report message to
|
50
|
-
# store on your server. Defaults to false.
|
51
|
-
attr_reader :hipaa_enabled
|
52
50
|
# @return [Array<Vapi::AssistantClientMessagesItem>] These are the messages that will be sent to your Client SDKs. Default is
|
53
51
|
# tatus-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input.
|
54
52
|
# You can check the shape of the messages in ClientMessage schema.
|
@@ -107,6 +105,8 @@ module Vapi
|
|
107
105
|
# @return [Array<String>] This list contains phrases that, if spoken by the assistant, will trigger the
|
108
106
|
# call to be hung up. Case insensitive.
|
109
107
|
attr_reader :end_call_phrases
|
108
|
+
# @return [Vapi::CompliancePlan]
|
109
|
+
attr_reader :compliance_plan
|
110
110
|
# @return [Hash{String => Object}] This is for metadata you want to store on the assistant.
|
111
111
|
attr_reader :metadata
|
112
112
|
# @return [Vapi::AnalysisPlan] This is the plan for analysis of assistant's calls. Stored in `call.analysis`.
|
@@ -161,6 +161,8 @@ module Vapi
|
|
161
161
|
# 2. phoneNumber.serverUrl
|
162
162
|
# 3. org.serverUrl
|
163
163
|
attr_reader :server
|
164
|
+
# @return [Array<Vapi::AssistantHooks>] This is a set of actions that will be performed on certain events.
|
165
|
+
attr_reader :hooks
|
164
166
|
# @return [String] This is the unique identifier for the assistant.
|
165
167
|
attr_reader :id
|
166
168
|
# @return [String] This is the unique identifier for the org that this assistant belongs to.
|
@@ -194,9 +196,6 @@ module Vapi
|
|
194
196
|
# state. (`assistant.model.messages` at call start, `call.messages` at squad
|
195
197
|
# transfer points).
|
196
198
|
# @default 'assistant-speaks-first'
|
197
|
-
# @param hipaa_enabled [Boolean] When this is enabled, no logs, recordings, or transcriptions will be stored. At
|
198
|
-
# the end of the call, you will still receive an end-of-call-report message to
|
199
|
-
# store on your server. Defaults to false.
|
200
199
|
# @param client_messages [Array<Vapi::AssistantClientMessagesItem>] These are the messages that will be sent to your Client SDKs. Default is
|
201
200
|
# tatus-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input.
|
202
201
|
# You can check the shape of the messages in ClientMessage schema.
|
@@ -241,6 +240,7 @@ module Vapi
|
|
241
240
|
# If unspecified, it will hang up without saying anything.
|
242
241
|
# @param end_call_phrases [Array<String>] This list contains phrases that, if spoken by the assistant, will trigger the
|
243
242
|
# call to be hung up. Case insensitive.
|
243
|
+
# @param compliance_plan [Vapi::CompliancePlan]
|
244
244
|
# @param metadata [Hash{String => Object}] This is for metadata you want to store on the assistant.
|
245
245
|
# @param analysis_plan [Vapi::AnalysisPlan] This is the plan for analysis of assistant's calls. Stored in `call.analysis`.
|
246
246
|
# @param artifact_plan [Vapi::ArtifactPlan] This is the plan for artifacts generated during assistant's calls. Stored in
|
@@ -286,6 +286,7 @@ module Vapi
|
|
286
286
|
# 1. assistant.server.url
|
287
287
|
# 2. phoneNumber.serverUrl
|
288
288
|
# 3. org.serverUrl
|
289
|
+
# @param hooks [Array<Vapi::AssistantHooks>] This is a set of actions that will be performed on certain events.
|
289
290
|
# @param id [String] This is the unique identifier for the assistant.
|
290
291
|
# @param org_id [String] This is the unique identifier for the org that this assistant belongs to.
|
291
292
|
# @param created_at [DateTime] This is the ISO 8601 date-time string of when the assistant was created.
|
@@ -293,13 +294,12 @@ module Vapi
|
|
293
294
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
294
295
|
# @return [Vapi::Assistant]
|
295
296
|
def initialize(id:, org_id:, created_at:, updated_at:, transcriber: OMIT, model: OMIT, voice: OMIT, first_message: OMIT, first_message_mode: OMIT,
|
296
|
-
|
297
|
+
client_messages: OMIT, server_messages: OMIT, silence_timeout_seconds: OMIT, max_duration_seconds: OMIT, background_sound: OMIT, background_denoising_enabled: OMIT, model_output_in_messages_enabled: OMIT, transport_configurations: OMIT, credentials: OMIT, name: OMIT, voicemail_detection: OMIT, voicemail_message: OMIT, end_call_message: OMIT, end_call_phrases: OMIT, compliance_plan: OMIT, metadata: OMIT, analysis_plan: OMIT, artifact_plan: OMIT, message_plan: OMIT, start_speaking_plan: OMIT, stop_speaking_plan: OMIT, monitor_plan: OMIT, credential_ids: OMIT, server: OMIT, hooks: OMIT, additional_properties: nil)
|
297
298
|
@transcriber = transcriber if transcriber != OMIT
|
298
299
|
@model = model if model != OMIT
|
299
300
|
@voice = voice if voice != OMIT
|
300
301
|
@first_message = first_message if first_message != OMIT
|
301
302
|
@first_message_mode = first_message_mode if first_message_mode != OMIT
|
302
|
-
@hipaa_enabled = hipaa_enabled if hipaa_enabled != OMIT
|
303
303
|
@client_messages = client_messages if client_messages != OMIT
|
304
304
|
@server_messages = server_messages if server_messages != OMIT
|
305
305
|
@silence_timeout_seconds = silence_timeout_seconds if silence_timeout_seconds != OMIT
|
@@ -314,6 +314,7 @@ module Vapi
|
|
314
314
|
@voicemail_message = voicemail_message if voicemail_message != OMIT
|
315
315
|
@end_call_message = end_call_message if end_call_message != OMIT
|
316
316
|
@end_call_phrases = end_call_phrases if end_call_phrases != OMIT
|
317
|
+
@compliance_plan = compliance_plan if compliance_plan != OMIT
|
317
318
|
@metadata = metadata if metadata != OMIT
|
318
319
|
@analysis_plan = analysis_plan if analysis_plan != OMIT
|
319
320
|
@artifact_plan = artifact_plan if artifact_plan != OMIT
|
@@ -323,6 +324,7 @@ module Vapi
|
|
323
324
|
@monitor_plan = monitor_plan if monitor_plan != OMIT
|
324
325
|
@credential_ids = credential_ids if credential_ids != OMIT
|
325
326
|
@server = server if server != OMIT
|
327
|
+
@hooks = hooks if hooks != OMIT
|
326
328
|
@id = id
|
327
329
|
@org_id = org_id
|
328
330
|
@created_at = created_at
|
@@ -334,7 +336,6 @@ module Vapi
|
|
334
336
|
"voice": voice,
|
335
337
|
"firstMessage": first_message,
|
336
338
|
"firstMessageMode": first_message_mode,
|
337
|
-
"hipaaEnabled": hipaa_enabled,
|
338
339
|
"clientMessages": client_messages,
|
339
340
|
"serverMessages": server_messages,
|
340
341
|
"silenceTimeoutSeconds": silence_timeout_seconds,
|
@@ -349,6 +350,7 @@ module Vapi
|
|
349
350
|
"voicemailMessage": voicemail_message,
|
350
351
|
"endCallMessage": end_call_message,
|
351
352
|
"endCallPhrases": end_call_phrases,
|
353
|
+
"compliancePlan": compliance_plan,
|
352
354
|
"metadata": metadata,
|
353
355
|
"analysisPlan": analysis_plan,
|
354
356
|
"artifactPlan": artifact_plan,
|
@@ -358,6 +360,7 @@ module Vapi
|
|
358
360
|
"monitorPlan": monitor_plan,
|
359
361
|
"credentialIds": credential_ids,
|
360
362
|
"server": server,
|
363
|
+
"hooks": hooks,
|
361
364
|
"id": id,
|
362
365
|
"orgId": org_id,
|
363
366
|
"createdAt": created_at,
|
@@ -394,7 +397,6 @@ module Vapi
|
|
394
397
|
end
|
395
398
|
first_message = parsed_json["firstMessage"]
|
396
399
|
first_message_mode = parsed_json["firstMessageMode"]
|
397
|
-
hipaa_enabled = parsed_json["hipaaEnabled"]
|
398
400
|
client_messages = parsed_json["clientMessages"]
|
399
401
|
server_messages = parsed_json["serverMessages"]
|
400
402
|
silence_timeout_seconds = parsed_json["silenceTimeoutSeconds"]
|
@@ -420,6 +422,12 @@ module Vapi
|
|
420
422
|
voicemail_message = parsed_json["voicemailMessage"]
|
421
423
|
end_call_message = parsed_json["endCallMessage"]
|
422
424
|
end_call_phrases = parsed_json["endCallPhrases"]
|
425
|
+
if parsed_json["compliancePlan"].nil?
|
426
|
+
compliance_plan = nil
|
427
|
+
else
|
428
|
+
compliance_plan = parsed_json["compliancePlan"].to_json
|
429
|
+
compliance_plan = Vapi::CompliancePlan.from_json(json_object: compliance_plan)
|
430
|
+
end
|
423
431
|
metadata = parsed_json["metadata"]
|
424
432
|
if parsed_json["analysisPlan"].nil?
|
425
433
|
analysis_plan = nil
|
@@ -464,6 +472,10 @@ module Vapi
|
|
464
472
|
server = parsed_json["server"].to_json
|
465
473
|
server = Vapi::Server.from_json(json_object: server)
|
466
474
|
end
|
475
|
+
hooks = parsed_json["hooks"]&.map do |item|
|
476
|
+
item = item.to_json
|
477
|
+
Vapi::AssistantHooks.from_json(json_object: item)
|
478
|
+
end
|
467
479
|
id = parsed_json["id"]
|
468
480
|
org_id = parsed_json["orgId"]
|
469
481
|
created_at = (DateTime.parse(parsed_json["createdAt"]) unless parsed_json["createdAt"].nil?)
|
@@ -474,7 +486,6 @@ module Vapi
|
|
474
486
|
voice: voice,
|
475
487
|
first_message: first_message,
|
476
488
|
first_message_mode: first_message_mode,
|
477
|
-
hipaa_enabled: hipaa_enabled,
|
478
489
|
client_messages: client_messages,
|
479
490
|
server_messages: server_messages,
|
480
491
|
silence_timeout_seconds: silence_timeout_seconds,
|
@@ -489,6 +500,7 @@ module Vapi
|
|
489
500
|
voicemail_message: voicemail_message,
|
490
501
|
end_call_message: end_call_message,
|
491
502
|
end_call_phrases: end_call_phrases,
|
503
|
+
compliance_plan: compliance_plan,
|
492
504
|
metadata: metadata,
|
493
505
|
analysis_plan: analysis_plan,
|
494
506
|
artifact_plan: artifact_plan,
|
@@ -498,6 +510,7 @@ module Vapi
|
|
498
510
|
monitor_plan: monitor_plan,
|
499
511
|
credential_ids: credential_ids,
|
500
512
|
server: server,
|
513
|
+
hooks: hooks,
|
501
514
|
id: id,
|
502
515
|
org_id: org_id,
|
503
516
|
created_at: created_at,
|
@@ -525,7 +538,6 @@ module Vapi
|
|
525
538
|
obj.voice.nil? || Vapi::AssistantVoice.validate_raw(obj: obj.voice)
|
526
539
|
obj.first_message&.is_a?(String) != false || raise("Passed value for field obj.first_message is not the expected type, validation failed.")
|
527
540
|
obj.first_message_mode&.is_a?(Vapi::AssistantFirstMessageMode) != false || raise("Passed value for field obj.first_message_mode is not the expected type, validation failed.")
|
528
|
-
obj.hipaa_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.hipaa_enabled is not the expected type, validation failed.")
|
529
541
|
obj.client_messages&.is_a?(Array) != false || raise("Passed value for field obj.client_messages is not the expected type, validation failed.")
|
530
542
|
obj.server_messages&.is_a?(Array) != false || raise("Passed value for field obj.server_messages is not the expected type, validation failed.")
|
531
543
|
obj.silence_timeout_seconds&.is_a?(Float) != false || raise("Passed value for field obj.silence_timeout_seconds is not the expected type, validation failed.")
|
@@ -540,6 +552,7 @@ module Vapi
|
|
540
552
|
obj.voicemail_message&.is_a?(String) != false || raise("Passed value for field obj.voicemail_message is not the expected type, validation failed.")
|
541
553
|
obj.end_call_message&.is_a?(String) != false || raise("Passed value for field obj.end_call_message is not the expected type, validation failed.")
|
542
554
|
obj.end_call_phrases&.is_a?(Array) != false || raise("Passed value for field obj.end_call_phrases is not the expected type, validation failed.")
|
555
|
+
obj.compliance_plan.nil? || Vapi::CompliancePlan.validate_raw(obj: obj.compliance_plan)
|
543
556
|
obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
|
544
557
|
obj.analysis_plan.nil? || Vapi::AnalysisPlan.validate_raw(obj: obj.analysis_plan)
|
545
558
|
obj.artifact_plan.nil? || Vapi::ArtifactPlan.validate_raw(obj: obj.artifact_plan)
|
@@ -549,6 +562,7 @@ module Vapi
|
|
549
562
|
obj.monitor_plan.nil? || Vapi::MonitorPlan.validate_raw(obj: obj.monitor_plan)
|
550
563
|
obj.credential_ids&.is_a?(Array) != false || raise("Passed value for field obj.credential_ids is not the expected type, validation failed.")
|
551
564
|
obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
|
565
|
+
obj.hooks&.is_a?(Array) != false || raise("Passed value for field obj.hooks is not the expected type, validation failed.")
|
552
566
|
obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
|
553
567
|
obj.org_id.is_a?(String) != false || raise("Passed value for field obj.org_id is not the expected type, validation failed.")
|
554
568
|
obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "ostruct"
|
4
|
+
require "json"
|
5
|
+
|
6
|
+
module Vapi
|
7
|
+
class AssistantHookActionBase
|
8
|
+
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
9
|
+
attr_reader :additional_properties
|
10
|
+
# @return [Object]
|
11
|
+
attr_reader :_field_set
|
12
|
+
protected :_field_set
|
13
|
+
|
14
|
+
OMIT = Object.new
|
15
|
+
|
16
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
17
|
+
# @return [Vapi::AssistantHookActionBase]
|
18
|
+
def initialize(additional_properties: nil)
|
19
|
+
@additional_properties = additional_properties
|
20
|
+
@_field_set = {}
|
21
|
+
end
|
22
|
+
|
23
|
+
# Deserialize a JSON object to an instance of AssistantHookActionBase
|
24
|
+
#
|
25
|
+
# @param json_object [String]
|
26
|
+
# @return [Vapi::AssistantHookActionBase]
|
27
|
+
def self.from_json(json_object:)
|
28
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
29
|
+
new(additional_properties: struct)
|
30
|
+
end
|
31
|
+
|
32
|
+
# Serialize an instance of AssistantHookActionBase to a JSON object
|
33
|
+
#
|
34
|
+
# @return [String]
|
35
|
+
def to_json(*_args)
|
36
|
+
@_field_set&.to_json
|
37
|
+
end
|
38
|
+
|
39
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
40
|
+
# hash and check each fields type against the current object's property
|
41
|
+
# definitions.
|
42
|
+
#
|
43
|
+
# @param obj [Object]
|
44
|
+
# @return [Void]
|
45
|
+
def self.validate_raw(obj:); end
|
46
|
+
end
|
47
|
+
end
|
@@ -0,0 +1,72 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "ostruct"
|
4
|
+
require "json"
|
5
|
+
|
6
|
+
module Vapi
|
7
|
+
class AssistantHookFilter
|
8
|
+
# @return [String] This is the type of filter - currently only "oneOf" is supported
|
9
|
+
attr_reader :type
|
10
|
+
# @return [String] This is the key to filter on (e.g. "call.endedReason")
|
11
|
+
attr_reader :key
|
12
|
+
# @return [Array<String>] This is the array of possible values to match against
|
13
|
+
attr_reader :one_of
|
14
|
+
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
15
|
+
attr_reader :additional_properties
|
16
|
+
# @return [Object]
|
17
|
+
attr_reader :_field_set
|
18
|
+
protected :_field_set
|
19
|
+
|
20
|
+
OMIT = Object.new
|
21
|
+
|
22
|
+
# @param type [String] This is the type of filter - currently only "oneOf" is supported
|
23
|
+
# @param key [String] This is the key to filter on (e.g. "call.endedReason")
|
24
|
+
# @param one_of [Array<String>] This is the array of possible values to match against
|
25
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
26
|
+
# @return [Vapi::AssistantHookFilter]
|
27
|
+
def initialize(type:, key:, one_of:, additional_properties: nil)
|
28
|
+
@type = type
|
29
|
+
@key = key
|
30
|
+
@one_of = one_of
|
31
|
+
@additional_properties = additional_properties
|
32
|
+
@_field_set = { "type": type, "key": key, "oneOf": one_of }
|
33
|
+
end
|
34
|
+
|
35
|
+
# Deserialize a JSON object to an instance of AssistantHookFilter
|
36
|
+
#
|
37
|
+
# @param json_object [String]
|
38
|
+
# @return [Vapi::AssistantHookFilter]
|
39
|
+
def self.from_json(json_object:)
|
40
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
41
|
+
parsed_json = JSON.parse(json_object)
|
42
|
+
type = parsed_json["type"]
|
43
|
+
key = parsed_json["key"]
|
44
|
+
one_of = parsed_json["oneOf"]
|
45
|
+
new(
|
46
|
+
type: type,
|
47
|
+
key: key,
|
48
|
+
one_of: one_of,
|
49
|
+
additional_properties: struct
|
50
|
+
)
|
51
|
+
end
|
52
|
+
|
53
|
+
# Serialize an instance of AssistantHookFilter to a JSON object
|
54
|
+
#
|
55
|
+
# @return [String]
|
56
|
+
def to_json(*_args)
|
57
|
+
@_field_set&.to_json
|
58
|
+
end
|
59
|
+
|
60
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
61
|
+
# hash and check each fields type against the current object's property
|
62
|
+
# definitions.
|
63
|
+
#
|
64
|
+
# @param obj [Object]
|
65
|
+
# @return [Void]
|
66
|
+
def self.validate_raw(obj:)
|
67
|
+
obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
|
68
|
+
obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
|
69
|
+
obj.one_of.is_a?(Array) != false || raise("Passed value for field obj.one_of is not the expected type, validation failed.")
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
@@ -0,0 +1,82 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "assistant_hook_filter"
|
4
|
+
require_relative "assistant_hook_action_base"
|
5
|
+
require "ostruct"
|
6
|
+
require "json"
|
7
|
+
|
8
|
+
module Vapi
|
9
|
+
class AssistantHooks
|
10
|
+
# @return [String] This is the event that triggers this hook
|
11
|
+
attr_reader :on
|
12
|
+
# @return [Array<Vapi::AssistantHookFilter>] This is the set of filters that must match for the hook to trigger
|
13
|
+
attr_reader :filters
|
14
|
+
# @return [Array<Vapi::AssistantHookActionBase>] This is the set of actions to perform when the hook triggers
|
15
|
+
attr_reader :do_
|
16
|
+
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
17
|
+
attr_reader :additional_properties
|
18
|
+
# @return [Object]
|
19
|
+
attr_reader :_field_set
|
20
|
+
protected :_field_set
|
21
|
+
|
22
|
+
OMIT = Object.new
|
23
|
+
|
24
|
+
# @param on [String] This is the event that triggers this hook
|
25
|
+
# @param filters [Array<Vapi::AssistantHookFilter>] This is the set of filters that must match for the hook to trigger
|
26
|
+
# @param do_ [Array<Vapi::AssistantHookActionBase>] This is the set of actions to perform when the hook triggers
|
27
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
28
|
+
# @return [Vapi::AssistantHooks]
|
29
|
+
def initialize(on:, do_:, filters: OMIT, additional_properties: nil)
|
30
|
+
@on = on
|
31
|
+
@filters = filters if filters != OMIT
|
32
|
+
@do_ = do_
|
33
|
+
@additional_properties = additional_properties
|
34
|
+
@_field_set = { "on": on, "filters": filters, "do": do_ }.reject do |_k, v|
|
35
|
+
v == OMIT
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
# Deserialize a JSON object to an instance of AssistantHooks
|
40
|
+
#
|
41
|
+
# @param json_object [String]
|
42
|
+
# @return [Vapi::AssistantHooks]
|
43
|
+
def self.from_json(json_object:)
|
44
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
45
|
+
parsed_json = JSON.parse(json_object)
|
46
|
+
on = parsed_json["on"]
|
47
|
+
filters = parsed_json["filters"]&.map do |item|
|
48
|
+
item = item.to_json
|
49
|
+
Vapi::AssistantHookFilter.from_json(json_object: item)
|
50
|
+
end
|
51
|
+
do_ = parsed_json["do"]&.map do |item|
|
52
|
+
item = item.to_json
|
53
|
+
Vapi::AssistantHookActionBase.from_json(json_object: item)
|
54
|
+
end
|
55
|
+
new(
|
56
|
+
on: on,
|
57
|
+
filters: filters,
|
58
|
+
do_: do_,
|
59
|
+
additional_properties: struct
|
60
|
+
)
|
61
|
+
end
|
62
|
+
|
63
|
+
# Serialize an instance of AssistantHooks to a JSON object
|
64
|
+
#
|
65
|
+
# @return [String]
|
66
|
+
def to_json(*_args)
|
67
|
+
@_field_set&.to_json
|
68
|
+
end
|
69
|
+
|
70
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
71
|
+
# hash and check each fields type against the current object's property
|
72
|
+
# definitions.
|
73
|
+
#
|
74
|
+
# @param obj [Object]
|
75
|
+
# @return [Void]
|
76
|
+
def self.validate_raw(obj:)
|
77
|
+
obj.on.is_a?(String) != false || raise("Passed value for field obj.on is not the expected type, validation failed.")
|
78
|
+
obj.filters&.is_a?(Array) != false || raise("Passed value for field obj.filters is not the expected type, validation failed.")
|
79
|
+
obj.do_.is_a?(Array) != false || raise("Passed value for field obj.do_ is not the expected type, validation failed.")
|
80
|
+
end
|
81
|
+
end
|
82
|
+
end
|
@@ -10,6 +10,7 @@ require_relative "assistant_overrides_background_sound"
|
|
10
10
|
require_relative "transport_configuration_twilio"
|
11
11
|
require_relative "assistant_overrides_credentials_item"
|
12
12
|
require_relative "twilio_voicemail_detection"
|
13
|
+
require_relative "compliance_plan"
|
13
14
|
require_relative "analysis_plan"
|
14
15
|
require_relative "artifact_plan"
|
15
16
|
require_relative "message_plan"
|
@@ -17,6 +18,7 @@ require_relative "start_speaking_plan"
|
|
17
18
|
require_relative "stop_speaking_plan"
|
18
19
|
require_relative "monitor_plan"
|
19
20
|
require_relative "server"
|
21
|
+
require_relative "assistant_hooks"
|
20
22
|
require "ostruct"
|
21
23
|
require "json"
|
22
24
|
|
@@ -44,10 +46,6 @@ module Vapi
|
|
44
46
|
# transfer points).
|
45
47
|
# @default 'assistant-speaks-first'
|
46
48
|
attr_reader :first_message_mode
|
47
|
-
# @return [Boolean] When this is enabled, no logs, recordings, or transcriptions will be stored. At
|
48
|
-
# the end of the call, you will still receive an end-of-call-report message to
|
49
|
-
# store on your server. Defaults to false.
|
50
|
-
attr_reader :hipaa_enabled
|
51
49
|
# @return [Array<Vapi::AssistantOverridesClientMessagesItem>] These are the messages that will be sent to your Client SDKs. Default is
|
52
50
|
# tatus-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input.
|
53
51
|
# You can check the shape of the messages in ClientMessage schema.
|
@@ -116,6 +114,8 @@ module Vapi
|
|
116
114
|
# @return [Array<String>] This list contains phrases that, if spoken by the assistant, will trigger the
|
117
115
|
# call to be hung up. Case insensitive.
|
118
116
|
attr_reader :end_call_phrases
|
117
|
+
# @return [Vapi::CompliancePlan]
|
118
|
+
attr_reader :compliance_plan
|
119
119
|
# @return [Hash{String => Object}] This is for metadata you want to store on the assistant.
|
120
120
|
attr_reader :metadata
|
121
121
|
# @return [Vapi::AnalysisPlan] This is the plan for analysis of assistant's calls. Stored in `call.analysis`.
|
@@ -170,6 +170,8 @@ module Vapi
|
|
170
170
|
# 2. phoneNumber.serverUrl
|
171
171
|
# 3. org.serverUrl
|
172
172
|
attr_reader :server
|
173
|
+
# @return [Array<Vapi::AssistantHooks>] This is a set of actions that will be performed on certain events.
|
174
|
+
attr_reader :hooks
|
173
175
|
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
174
176
|
attr_reader :additional_properties
|
175
177
|
# @return [Object]
|
@@ -195,9 +197,6 @@ module Vapi
|
|
195
197
|
# state. (`assistant.model.messages` at call start, `call.messages` at squad
|
196
198
|
# transfer points).
|
197
199
|
# @default 'assistant-speaks-first'
|
198
|
-
# @param hipaa_enabled [Boolean] When this is enabled, no logs, recordings, or transcriptions will be stored. At
|
199
|
-
# the end of the call, you will still receive an end-of-call-report message to
|
200
|
-
# store on your server. Defaults to false.
|
201
200
|
# @param client_messages [Array<Vapi::AssistantOverridesClientMessagesItem>] These are the messages that will be sent to your Client SDKs. Default is
|
202
201
|
# tatus-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input.
|
203
202
|
# You can check the shape of the messages in ClientMessage schema.
|
@@ -251,6 +250,7 @@ module Vapi
|
|
251
250
|
# If unspecified, it will hang up without saying anything.
|
252
251
|
# @param end_call_phrases [Array<String>] This list contains phrases that, if spoken by the assistant, will trigger the
|
253
252
|
# call to be hung up. Case insensitive.
|
253
|
+
# @param compliance_plan [Vapi::CompliancePlan]
|
254
254
|
# @param metadata [Hash{String => Object}] This is for metadata you want to store on the assistant.
|
255
255
|
# @param analysis_plan [Vapi::AnalysisPlan] This is the plan for analysis of assistant's calls. Stored in `call.analysis`.
|
256
256
|
# @param artifact_plan [Vapi::ArtifactPlan] This is the plan for artifacts generated during assistant's calls. Stored in
|
@@ -296,16 +296,16 @@ module Vapi
|
|
296
296
|
# 1. assistant.server.url
|
297
297
|
# 2. phoneNumber.serverUrl
|
298
298
|
# 3. org.serverUrl
|
299
|
+
# @param hooks [Array<Vapi::AssistantHooks>] This is a set of actions that will be performed on certain events.
|
299
300
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
300
301
|
# @return [Vapi::AssistantOverrides]
|
301
302
|
def initialize(transcriber: OMIT, model: OMIT, voice: OMIT, first_message: OMIT, first_message_mode: OMIT,
|
302
|
-
|
303
|
+
client_messages: OMIT, server_messages: OMIT, silence_timeout_seconds: OMIT, max_duration_seconds: OMIT, background_sound: OMIT, background_denoising_enabled: OMIT, model_output_in_messages_enabled: OMIT, transport_configurations: OMIT, credentials: OMIT, variable_values: OMIT, name: OMIT, voicemail_detection: OMIT, voicemail_message: OMIT, end_call_message: OMIT, end_call_phrases: OMIT, compliance_plan: OMIT, metadata: OMIT, analysis_plan: OMIT, artifact_plan: OMIT, message_plan: OMIT, start_speaking_plan: OMIT, stop_speaking_plan: OMIT, monitor_plan: OMIT, credential_ids: OMIT, server: OMIT, hooks: OMIT, additional_properties: nil)
|
303
304
|
@transcriber = transcriber if transcriber != OMIT
|
304
305
|
@model = model if model != OMIT
|
305
306
|
@voice = voice if voice != OMIT
|
306
307
|
@first_message = first_message if first_message != OMIT
|
307
308
|
@first_message_mode = first_message_mode if first_message_mode != OMIT
|
308
|
-
@hipaa_enabled = hipaa_enabled if hipaa_enabled != OMIT
|
309
309
|
@client_messages = client_messages if client_messages != OMIT
|
310
310
|
@server_messages = server_messages if server_messages != OMIT
|
311
311
|
@silence_timeout_seconds = silence_timeout_seconds if silence_timeout_seconds != OMIT
|
@@ -321,6 +321,7 @@ module Vapi
|
|
321
321
|
@voicemail_message = voicemail_message if voicemail_message != OMIT
|
322
322
|
@end_call_message = end_call_message if end_call_message != OMIT
|
323
323
|
@end_call_phrases = end_call_phrases if end_call_phrases != OMIT
|
324
|
+
@compliance_plan = compliance_plan if compliance_plan != OMIT
|
324
325
|
@metadata = metadata if metadata != OMIT
|
325
326
|
@analysis_plan = analysis_plan if analysis_plan != OMIT
|
326
327
|
@artifact_plan = artifact_plan if artifact_plan != OMIT
|
@@ -330,6 +331,7 @@ module Vapi
|
|
330
331
|
@monitor_plan = monitor_plan if monitor_plan != OMIT
|
331
332
|
@credential_ids = credential_ids if credential_ids != OMIT
|
332
333
|
@server = server if server != OMIT
|
334
|
+
@hooks = hooks if hooks != OMIT
|
333
335
|
@additional_properties = additional_properties
|
334
336
|
@_field_set = {
|
335
337
|
"transcriber": transcriber,
|
@@ -337,7 +339,6 @@ module Vapi
|
|
337
339
|
"voice": voice,
|
338
340
|
"firstMessage": first_message,
|
339
341
|
"firstMessageMode": first_message_mode,
|
340
|
-
"hipaaEnabled": hipaa_enabled,
|
341
342
|
"clientMessages": client_messages,
|
342
343
|
"serverMessages": server_messages,
|
343
344
|
"silenceTimeoutSeconds": silence_timeout_seconds,
|
@@ -353,6 +354,7 @@ module Vapi
|
|
353
354
|
"voicemailMessage": voicemail_message,
|
354
355
|
"endCallMessage": end_call_message,
|
355
356
|
"endCallPhrases": end_call_phrases,
|
357
|
+
"compliancePlan": compliance_plan,
|
356
358
|
"metadata": metadata,
|
357
359
|
"analysisPlan": analysis_plan,
|
358
360
|
"artifactPlan": artifact_plan,
|
@@ -361,7 +363,8 @@ module Vapi
|
|
361
363
|
"stopSpeakingPlan": stop_speaking_plan,
|
362
364
|
"monitorPlan": monitor_plan,
|
363
365
|
"credentialIds": credential_ids,
|
364
|
-
"server": server
|
366
|
+
"server": server,
|
367
|
+
"hooks": hooks
|
365
368
|
}.reject do |_k, v|
|
366
369
|
v == OMIT
|
367
370
|
end
|
@@ -394,7 +397,6 @@ module Vapi
|
|
394
397
|
end
|
395
398
|
first_message = parsed_json["firstMessage"]
|
396
399
|
first_message_mode = parsed_json["firstMessageMode"]
|
397
|
-
hipaa_enabled = parsed_json["hipaaEnabled"]
|
398
400
|
client_messages = parsed_json["clientMessages"]
|
399
401
|
server_messages = parsed_json["serverMessages"]
|
400
402
|
silence_timeout_seconds = parsed_json["silenceTimeoutSeconds"]
|
@@ -421,6 +423,12 @@ module Vapi
|
|
421
423
|
voicemail_message = parsed_json["voicemailMessage"]
|
422
424
|
end_call_message = parsed_json["endCallMessage"]
|
423
425
|
end_call_phrases = parsed_json["endCallPhrases"]
|
426
|
+
if parsed_json["compliancePlan"].nil?
|
427
|
+
compliance_plan = nil
|
428
|
+
else
|
429
|
+
compliance_plan = parsed_json["compliancePlan"].to_json
|
430
|
+
compliance_plan = Vapi::CompliancePlan.from_json(json_object: compliance_plan)
|
431
|
+
end
|
424
432
|
metadata = parsed_json["metadata"]
|
425
433
|
if parsed_json["analysisPlan"].nil?
|
426
434
|
analysis_plan = nil
|
@@ -465,13 +473,16 @@ module Vapi
|
|
465
473
|
server = parsed_json["server"].to_json
|
466
474
|
server = Vapi::Server.from_json(json_object: server)
|
467
475
|
end
|
476
|
+
hooks = parsed_json["hooks"]&.map do |item|
|
477
|
+
item = item.to_json
|
478
|
+
Vapi::AssistantHooks.from_json(json_object: item)
|
479
|
+
end
|
468
480
|
new(
|
469
481
|
transcriber: transcriber,
|
470
482
|
model: model,
|
471
483
|
voice: voice,
|
472
484
|
first_message: first_message,
|
473
485
|
first_message_mode: first_message_mode,
|
474
|
-
hipaa_enabled: hipaa_enabled,
|
475
486
|
client_messages: client_messages,
|
476
487
|
server_messages: server_messages,
|
477
488
|
silence_timeout_seconds: silence_timeout_seconds,
|
@@ -487,6 +498,7 @@ module Vapi
|
|
487
498
|
voicemail_message: voicemail_message,
|
488
499
|
end_call_message: end_call_message,
|
489
500
|
end_call_phrases: end_call_phrases,
|
501
|
+
compliance_plan: compliance_plan,
|
490
502
|
metadata: metadata,
|
491
503
|
analysis_plan: analysis_plan,
|
492
504
|
artifact_plan: artifact_plan,
|
@@ -496,6 +508,7 @@ module Vapi
|
|
496
508
|
monitor_plan: monitor_plan,
|
497
509
|
credential_ids: credential_ids,
|
498
510
|
server: server,
|
511
|
+
hooks: hooks,
|
499
512
|
additional_properties: struct
|
500
513
|
)
|
501
514
|
end
|
@@ -519,7 +532,6 @@ module Vapi
|
|
519
532
|
obj.voice.nil? || Vapi::AssistantOverridesVoice.validate_raw(obj: obj.voice)
|
520
533
|
obj.first_message&.is_a?(String) != false || raise("Passed value for field obj.first_message is not the expected type, validation failed.")
|
521
534
|
obj.first_message_mode&.is_a?(Vapi::AssistantOverridesFirstMessageMode) != false || raise("Passed value for field obj.first_message_mode is not the expected type, validation failed.")
|
522
|
-
obj.hipaa_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.hipaa_enabled is not the expected type, validation failed.")
|
523
535
|
obj.client_messages&.is_a?(Array) != false || raise("Passed value for field obj.client_messages is not the expected type, validation failed.")
|
524
536
|
obj.server_messages&.is_a?(Array) != false || raise("Passed value for field obj.server_messages is not the expected type, validation failed.")
|
525
537
|
obj.silence_timeout_seconds&.is_a?(Float) != false || raise("Passed value for field obj.silence_timeout_seconds is not the expected type, validation failed.")
|
@@ -535,6 +547,7 @@ module Vapi
|
|
535
547
|
obj.voicemail_message&.is_a?(String) != false || raise("Passed value for field obj.voicemail_message is not the expected type, validation failed.")
|
536
548
|
obj.end_call_message&.is_a?(String) != false || raise("Passed value for field obj.end_call_message is not the expected type, validation failed.")
|
537
549
|
obj.end_call_phrases&.is_a?(Array) != false || raise("Passed value for field obj.end_call_phrases is not the expected type, validation failed.")
|
550
|
+
obj.compliance_plan.nil? || Vapi::CompliancePlan.validate_raw(obj: obj.compliance_plan)
|
538
551
|
obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
|
539
552
|
obj.analysis_plan.nil? || Vapi::AnalysisPlan.validate_raw(obj: obj.analysis_plan)
|
540
553
|
obj.artifact_plan.nil? || Vapi::ArtifactPlan.validate_raw(obj: obj.artifact_plan)
|
@@ -544,6 +557,7 @@ module Vapi
|
|
544
557
|
obj.monitor_plan.nil? || Vapi::MonitorPlan.validate_raw(obj: obj.monitor_plan)
|
545
558
|
obj.credential_ids&.is_a?(Array) != false || raise("Passed value for field obj.credential_ids is not the expected type, validation failed.")
|
546
559
|
obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
|
560
|
+
obj.hooks&.is_a?(Array) != false || raise("Passed value for field obj.hooks is not the expected type, validation failed.")
|
547
561
|
end
|
548
562
|
end
|
549
563
|
end
|
@@ -13,6 +13,7 @@ module Vapi
|
|
13
13
|
SPEECH_UPDATE = "speech-update"
|
14
14
|
STATUS_UPDATE = "status-update"
|
15
15
|
TRANSCRIPT = "transcript"
|
16
|
+
TRANSCRIPT_TRANSCRIPT_TYPE_FINAL = "transcript[transcriptType='final']"
|
16
17
|
TOOL_CALLS = "tool-calls"
|
17
18
|
TRANSFER_DESTINATION_REQUEST = "transfer-destination-request"
|
18
19
|
TRANSFER_UPDATE = "transfer-update"
|
@@ -13,6 +13,7 @@ module Vapi
|
|
13
13
|
SPEECH_UPDATE = "speech-update"
|
14
14
|
STATUS_UPDATE = "status-update"
|
15
15
|
TRANSCRIPT = "transcript"
|
16
|
+
TRANSCRIPT_TRANSCRIPT_TYPE_FINAL = "transcript[transcriptType='final']"
|
16
17
|
TOOL_CALLS = "tool-calls"
|
17
18
|
TRANSFER_DESTINATION_REQUEST = "transfer-destination-request"
|
18
19
|
TRANSFER_UPDATE = "transfer-update"
|
@@ -4,12 +4,14 @@ module Vapi
|
|
4
4
|
# This is the region of the Azure resource.
|
5
5
|
class AzureCredentialRegion
|
6
6
|
AUSTRALIA = "australia"
|
7
|
-
|
7
|
+
CANADAEAST = "canadaeast"
|
8
|
+
CANADACENTRAL = "canadacentral"
|
8
9
|
EASTUS_2 = "eastus2"
|
9
10
|
EASTUS = "eastus"
|
10
11
|
FRANCE = "france"
|
11
12
|
INDIA = "india"
|
12
|
-
|
13
|
+
JAPANEAST = "japaneast"
|
14
|
+
JAPANWEST = "japanwest"
|
13
15
|
UAENORTH = "uaenorth"
|
14
16
|
NORTHCENTRALUS = "northcentralus"
|
15
17
|
NORWAY = "norway"
|
@@ -3,12 +3,14 @@
|
|
3
3
|
module Vapi
|
4
4
|
class AzureOpenAiCredentialRegion
|
5
5
|
AUSTRALIA = "australia"
|
6
|
-
|
6
|
+
CANADAEAST = "canadaeast"
|
7
|
+
CANADACENTRAL = "canadacentral"
|
7
8
|
EASTUS_2 = "eastus2"
|
8
9
|
EASTUS = "eastus"
|
9
10
|
FRANCE = "france"
|
10
11
|
INDIA = "india"
|
11
|
-
|
12
|
+
JAPANEAST = "japaneast"
|
13
|
+
JAPANWEST = "japanwest"
|
12
14
|
UAENORTH = "uaenorth"
|
13
15
|
NORTHCENTRALUS = "northcentralus"
|
14
16
|
NORWAY = "norway"
|