vapi_server_sdk 0.0.0.pre.alpha7
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 +7 -0
- data/lib/core/file_utilities.rb +26 -0
- data/lib/environment.rb +7 -0
- data/lib/gemconfig.rb +14 -0
- data/lib/requests.rb +174 -0
- data/lib/types_export.rb +526 -0
- data/lib/vapi_server_sdk/analytics/client.rb +115 -0
- data/lib/vapi_server_sdk/assistants/client.rb +949 -0
- data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_background_sound.rb +12 -0
- data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_client_messages_item.rb +22 -0
- data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_first_message_mode.rb +21 -0
- data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_model.rb +201 -0
- data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_server_messages_item.rb +23 -0
- data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_transcriber.rb +110 -0
- data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_voice.rb +188 -0
- data/lib/vapi_server_sdk/blocks/client.rb +552 -0
- data/lib/vapi_server_sdk/blocks/types/blocks_create_request.rb +109 -0
- data/lib/vapi_server_sdk/blocks/types/blocks_create_response.rb +109 -0
- data/lib/vapi_server_sdk/blocks/types/blocks_delete_response.rb +109 -0
- data/lib/vapi_server_sdk/blocks/types/blocks_get_response.rb +109 -0
- data/lib/vapi_server_sdk/blocks/types/blocks_list_response_item.rb +109 -0
- data/lib/vapi_server_sdk/blocks/types/blocks_update_response.rb +109 -0
- data/lib/vapi_server_sdk/blocks/types/update_block_dto_messages_item.rb +96 -0
- data/lib/vapi_server_sdk/blocks/types/update_block_dto_steps_item.rb +96 -0
- data/lib/vapi_server_sdk/blocks/types/update_block_dto_tool.rb +163 -0
- data/lib/vapi_server_sdk/calls/client.rb +966 -0
- data/lib/vapi_server_sdk/files/client.rb +347 -0
- data/lib/vapi_server_sdk/logs/client.rb +174 -0
- data/lib/vapi_server_sdk/logs/types/logs_get_request_sort_order.rb +10 -0
- data/lib/vapi_server_sdk/logs/types/logs_get_request_type.rb +12 -0
- data/lib/vapi_server_sdk/phone_numbers/client.rb +455 -0
- data/lib/vapi_server_sdk/phone_numbers/types/phone_numbers_create_request.rb +122 -0
- data/lib/vapi_server_sdk/phone_numbers/types/phone_numbers_create_response.rb +122 -0
- data/lib/vapi_server_sdk/phone_numbers/types/phone_numbers_delete_response.rb +122 -0
- data/lib/vapi_server_sdk/phone_numbers/types/phone_numbers_get_response.rb +122 -0
- data/lib/vapi_server_sdk/phone_numbers/types/phone_numbers_list_response_item.rb +122 -0
- data/lib/vapi_server_sdk/phone_numbers/types/phone_numbers_update_response.rb +122 -0
- data/lib/vapi_server_sdk/phone_numbers/types/update_phone_number_dto_fallback_destination.rb +103 -0
- data/lib/vapi_server_sdk/squads/client.rb +1050 -0
- data/lib/vapi_server_sdk/tools/client.rb +473 -0
- data/lib/vapi_server_sdk/tools/types/tools_create_request.rb +161 -0
- data/lib/vapi_server_sdk/tools/types/tools_create_response.rb +161 -0
- data/lib/vapi_server_sdk/tools/types/tools_delete_response.rb +161 -0
- data/lib/vapi_server_sdk/tools/types/tools_get_response.rb +161 -0
- data/lib/vapi_server_sdk/tools/types/tools_list_response_item.rb +161 -0
- data/lib/vapi_server_sdk/tools/types/tools_update_response.rb +161 -0
- data/lib/vapi_server_sdk/tools/types/update_tool_dto_messages_item.rb +122 -0
- data/lib/vapi_server_sdk/types/add_voice_to_provider_dto.rb +78 -0
- data/lib/vapi_server_sdk/types/analysis.rb +88 -0
- data/lib/vapi_server_sdk/types/analysis_cost.rb +93 -0
- data/lib/vapi_server_sdk/types/analysis_cost_analysis_type.rb +10 -0
- data/lib/vapi_server_sdk/types/analysis_cost_breakdown.rb +137 -0
- data/lib/vapi_server_sdk/types/analysis_plan.rb +103 -0
- data/lib/vapi_server_sdk/types/analytics_operation.rb +76 -0
- data/lib/vapi_server_sdk/types/analytics_operation_column.rb +17 -0
- data/lib/vapi_server_sdk/types/analytics_operation_operation.rb +12 -0
- data/lib/vapi_server_sdk/types/analytics_query.rb +107 -0
- data/lib/vapi_server_sdk/types/analytics_query_group_by_item.rb +11 -0
- data/lib/vapi_server_sdk/types/analytics_query_result.rb +96 -0
- data/lib/vapi_server_sdk/types/anthropic_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/anthropic_model.rb +170 -0
- data/lib/vapi_server_sdk/types/anthropic_model_model.rb +11 -0
- data/lib/vapi_server_sdk/types/anthropic_model_tools_item.rb +159 -0
- data/lib/vapi_server_sdk/types/anyscale_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/anyscale_model.rb +169 -0
- data/lib/vapi_server_sdk/types/anyscale_model_tools_item.rb +159 -0
- data/lib/vapi_server_sdk/types/artifact.rb +133 -0
- data/lib/vapi_server_sdk/types/artifact_messages_item.rb +96 -0
- data/lib/vapi_server_sdk/types/artifact_plan.rb +139 -0
- data/lib/vapi_server_sdk/types/assignment_mutation.rb +189 -0
- data/lib/vapi_server_sdk/types/assignment_mutation_conditions_item.rb +94 -0
- data/lib/vapi_server_sdk/types/assistant.rb +562 -0
- data/lib/vapi_server_sdk/types/assistant_background_sound.rb +10 -0
- data/lib/vapi_server_sdk/types/assistant_client_messages_item.rb +20 -0
- data/lib/vapi_server_sdk/types/assistant_first_message_mode.rb +19 -0
- data/lib/vapi_server_sdk/types/assistant_model.rb +199 -0
- data/lib/vapi_server_sdk/types/assistant_overrides.rb +539 -0
- data/lib/vapi_server_sdk/types/assistant_overrides_background_sound.rb +10 -0
- data/lib/vapi_server_sdk/types/assistant_overrides_client_messages_item.rb +20 -0
- data/lib/vapi_server_sdk/types/assistant_overrides_first_message_mode.rb +19 -0
- data/lib/vapi_server_sdk/types/assistant_overrides_model.rb +199 -0
- data/lib/vapi_server_sdk/types/assistant_overrides_server_messages_item.rb +21 -0
- data/lib/vapi_server_sdk/types/assistant_overrides_transcriber.rb +108 -0
- data/lib/vapi_server_sdk/types/assistant_overrides_voice.rb +186 -0
- data/lib/vapi_server_sdk/types/assistant_server_messages_item.rb +21 -0
- data/lib/vapi_server_sdk/types/assistant_transcriber.rb +108 -0
- data/lib/vapi_server_sdk/types/assistant_voice.rb +186 -0
- data/lib/vapi_server_sdk/types/azure_open_ai_credential.rb +128 -0
- data/lib/vapi_server_sdk/types/azure_open_ai_credential_models_item.rb +14 -0
- data/lib/vapi_server_sdk/types/azure_open_ai_credential_region.rb +21 -0
- data/lib/vapi_server_sdk/types/azure_voice.rb +104 -0
- data/lib/vapi_server_sdk/types/azure_voice_id.rb +53 -0
- data/lib/vapi_server_sdk/types/azure_voice_id_enum.rb +9 -0
- data/lib/vapi_server_sdk/types/block_complete_message.rb +73 -0
- data/lib/vapi_server_sdk/types/block_complete_message_conditions_item.rb +94 -0
- data/lib/vapi_server_sdk/types/block_start_message.rb +73 -0
- data/lib/vapi_server_sdk/types/block_start_message_conditions_item.rb +94 -0
- data/lib/vapi_server_sdk/types/bot_message.rb +111 -0
- data/lib/vapi_server_sdk/types/bucket_plan.rb +139 -0
- data/lib/vapi_server_sdk/types/buy_phone_number_dto.rb +151 -0
- data/lib/vapi_server_sdk/types/buy_phone_number_dto_fallback_destination.rb +100 -0
- data/lib/vapi_server_sdk/types/byo_phone_number.rb +224 -0
- data/lib/vapi_server_sdk/types/byo_phone_number_fallback_destination.rb +100 -0
- data/lib/vapi_server_sdk/types/byo_sip_trunk_credential.rb +166 -0
- data/lib/vapi_server_sdk/types/call.rb +425 -0
- data/lib/vapi_server_sdk/types/call_costs_item.rb +146 -0
- data/lib/vapi_server_sdk/types/call_destination.rb +96 -0
- data/lib/vapi_server_sdk/types/call_ended_reason.rb +175 -0
- data/lib/vapi_server_sdk/types/call_messages_item.rb +96 -0
- data/lib/vapi_server_sdk/types/call_paginated_response.rb +75 -0
- data/lib/vapi_server_sdk/types/call_phone_call_provider.rb +11 -0
- data/lib/vapi_server_sdk/types/call_phone_call_transport.rb +10 -0
- data/lib/vapi_server_sdk/types/call_status.rb +12 -0
- data/lib/vapi_server_sdk/types/call_type.rb +10 -0
- data/lib/vapi_server_sdk/types/callback_step.rb +204 -0
- data/lib/vapi_server_sdk/types/callback_step_block.rb +108 -0
- data/lib/vapi_server_sdk/types/cartesia_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/cartesia_voice.rb +113 -0
- data/lib/vapi_server_sdk/types/cartesia_voice_language.rb +15 -0
- data/lib/vapi_server_sdk/types/cartesia_voice_model.rb +10 -0
- data/lib/vapi_server_sdk/types/chunk_plan.rb +128 -0
- data/lib/vapi_server_sdk/types/client_inbound_message.rb +63 -0
- data/lib/vapi_server_sdk/types/client_inbound_message_add_message.rb +61 -0
- data/lib/vapi_server_sdk/types/client_inbound_message_control.rb +56 -0
- data/lib/vapi_server_sdk/types/client_inbound_message_control_control.rb +10 -0
- data/lib/vapi_server_sdk/types/client_inbound_message_message.rb +109 -0
- data/lib/vapi_server_sdk/types/client_inbound_message_say.rb +67 -0
- data/lib/vapi_server_sdk/types/client_message.rb +65 -0
- data/lib/vapi_server_sdk/types/client_message_conversation_update.rb +79 -0
- data/lib/vapi_server_sdk/types/client_message_conversation_update_messages_item.rb +97 -0
- data/lib/vapi_server_sdk/types/client_message_hang.rb +47 -0
- data/lib/vapi_server_sdk/types/client_message_language_changed.rb +55 -0
- data/lib/vapi_server_sdk/types/client_message_message.rb +214 -0
- data/lib/vapi_server_sdk/types/client_message_metadata.rb +55 -0
- data/lib/vapi_server_sdk/types/client_message_model_output.rb +55 -0
- data/lib/vapi_server_sdk/types/client_message_speech_update.rb +67 -0
- data/lib/vapi_server_sdk/types/client_message_speech_update_role.rb +9 -0
- data/lib/vapi_server_sdk/types/client_message_speech_update_status.rb +9 -0
- data/lib/vapi_server_sdk/types/client_message_tool_calls.rb +75 -0
- data/lib/vapi_server_sdk/types/client_message_tool_calls_result.rb +55 -0
- data/lib/vapi_server_sdk/types/client_message_tool_calls_tool_with_tool_call_list_item.rb +108 -0
- data/lib/vapi_server_sdk/types/client_message_transcript.rb +74 -0
- data/lib/vapi_server_sdk/types/client_message_transcript_role.rb +9 -0
- data/lib/vapi_server_sdk/types/client_message_transcript_transcript_type.rb +9 -0
- data/lib/vapi_server_sdk/types/client_message_user_interrupted.rb +47 -0
- data/lib/vapi_server_sdk/types/client_message_voice_input.rb +55 -0
- data/lib/vapi_server_sdk/types/clone_voice_dto.rb +83 -0
- data/lib/vapi_server_sdk/types/condition.rb +73 -0
- data/lib/vapi_server_sdk/types/condition_operator.rb +13 -0
- data/lib/vapi_server_sdk/types/conversation_block.rb +239 -0
- data/lib/vapi_server_sdk/types/conversation_block_messages_item.rb +94 -0
- data/lib/vapi_server_sdk/types/cost_breakdown.rb +141 -0
- data/lib/vapi_server_sdk/types/create_anthropic_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_anyscale_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_assistant_dto.rb +529 -0
- data/lib/vapi_server_sdk/types/create_assistant_dto_background_sound.rb +10 -0
- data/lib/vapi_server_sdk/types/create_assistant_dto_client_messages_item.rb +20 -0
- data/lib/vapi_server_sdk/types/create_assistant_dto_first_message_mode.rb +19 -0
- data/lib/vapi_server_sdk/types/create_assistant_dto_model.rb +199 -0
- data/lib/vapi_server_sdk/types/create_assistant_dto_server_messages_item.rb +21 -0
- data/lib/vapi_server_sdk/types/create_assistant_dto_transcriber.rb +108 -0
- data/lib/vapi_server_sdk/types/create_assistant_dto_voice.rb +186 -0
- data/lib/vapi_server_sdk/types/create_azure_open_ai_credential_dto.rb +94 -0
- data/lib/vapi_server_sdk/types/create_azure_open_ai_credential_dto_models_item.rb +14 -0
- data/lib/vapi_server_sdk/types/create_azure_open_ai_credential_dto_region.rb +21 -0
- data/lib/vapi_server_sdk/types/create_byo_phone_number_dto.rb +191 -0
- data/lib/vapi_server_sdk/types/create_byo_phone_number_dto_fallback_destination.rb +101 -0
- data/lib/vapi_server_sdk/types/create_byo_sip_trunk_credential_dto.rb +133 -0
- data/lib/vapi_server_sdk/types/create_cartesia_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_conversation_block_dto.rb +206 -0
- data/lib/vapi_server_sdk/types/create_conversation_block_dto_messages_item.rb +95 -0
- data/lib/vapi_server_sdk/types/create_custom_llm_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_customer_dto.rb +117 -0
- data/lib/vapi_server_sdk/types/create_deep_infra_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_deepgram_credential_dto.rb +76 -0
- data/lib/vapi_server_sdk/types/create_dtmf_tool_dto.rb +139 -0
- data/lib/vapi_server_sdk/types/create_dtmf_tool_dto_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/create_eleven_labs_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_end_call_tool_dto.rb +139 -0
- data/lib/vapi_server_sdk/types/create_end_call_tool_dto_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/create_function_tool_dto.rb +139 -0
- data/lib/vapi_server_sdk/types/create_function_tool_dto_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/create_gcp_credential_dto.rb +104 -0
- data/lib/vapi_server_sdk/types/create_ghl_tool_dto.rb +158 -0
- data/lib/vapi_server_sdk/types/create_ghl_tool_dto_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/create_gladia_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_go_high_level_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_groq_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_lmnt_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_make_credential_dto.rb +79 -0
- data/lib/vapi_server_sdk/types/create_make_tool_dto.rb +158 -0
- data/lib/vapi_server_sdk/types/create_make_tool_dto_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/create_open_ai_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_open_router_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_org_dto.rb +129 -0
- data/lib/vapi_server_sdk/types/create_outbound_call_dto.rb +191 -0
- data/lib/vapi_server_sdk/types/create_output_tool_dto.rb +139 -0
- data/lib/vapi_server_sdk/types/create_output_tool_dto_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/create_perplexity_ai_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_play_ht_credential_dto.rb +72 -0
- data/lib/vapi_server_sdk/types/create_rime_ai_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_runpod_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_s_3_credential_dto.rb +101 -0
- data/lib/vapi_server_sdk/types/create_squad_dto.rb +94 -0
- data/lib/vapi_server_sdk/types/create_together_ai_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/create_token_dto.rb +81 -0
- data/lib/vapi_server_sdk/types/create_token_dto_tag.rb +9 -0
- data/lib/vapi_server_sdk/types/create_tool_call_block_dto.rb +168 -0
- data/lib/vapi_server_sdk/types/create_tool_call_block_dto_messages_item.rb +94 -0
- data/lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb +161 -0
- data/lib/vapi_server_sdk/types/create_tool_template_dto.rb +131 -0
- data/lib/vapi_server_sdk/types/create_tool_template_dto_details.rb +159 -0
- data/lib/vapi_server_sdk/types/create_tool_template_dto_provider.rb +9 -0
- data/lib/vapi_server_sdk/types/create_tool_template_dto_provider_details.rb +107 -0
- data/lib/vapi_server_sdk/types/create_tool_template_dto_visibility.rb +8 -0
- data/lib/vapi_server_sdk/types/create_transfer_call_tool_dto.rb +161 -0
- data/lib/vapi_server_sdk/types/create_transfer_call_tool_dto_destinations_item.rb +121 -0
- data/lib/vapi_server_sdk/types/create_transfer_call_tool_dto_messages_item.rb +121 -0
- data/lib/vapi_server_sdk/types/create_twilio_credential_dto.rb +72 -0
- data/lib/vapi_server_sdk/types/create_twilio_phone_number_dto.rb +167 -0
- data/lib/vapi_server_sdk/types/create_twilio_phone_number_dto_fallback_destination.rb +101 -0
- data/lib/vapi_server_sdk/types/create_vapi_phone_number_dto.rb +155 -0
- data/lib/vapi_server_sdk/types/create_vapi_phone_number_dto_fallback_destination.rb +101 -0
- data/lib/vapi_server_sdk/types/create_voicemail_tool_dto.rb +139 -0
- data/lib/vapi_server_sdk/types/create_voicemail_tool_dto_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/create_vonage_credential_dto.rb +72 -0
- data/lib/vapi_server_sdk/types/create_vonage_phone_number_dto.rb +161 -0
- data/lib/vapi_server_sdk/types/create_vonage_phone_number_dto_fallback_destination.rb +101 -0
- data/lib/vapi_server_sdk/types/create_web_call_dto.rb +123 -0
- data/lib/vapi_server_sdk/types/create_workflow_block_dto.rb +154 -0
- data/lib/vapi_server_sdk/types/create_workflow_block_dto_messages_item.rb +94 -0
- data/lib/vapi_server_sdk/types/create_workflow_block_dto_steps_item.rb +94 -0
- data/lib/vapi_server_sdk/types/custom_llm_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/custom_llm_model.rb +204 -0
- data/lib/vapi_server_sdk/types/custom_llm_model_metadata_send_mode.rb +18 -0
- data/lib/vapi_server_sdk/types/custom_llm_model_tools_item.rb +159 -0
- data/lib/vapi_server_sdk/types/deep_infra_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/deep_infra_model.rb +169 -0
- data/lib/vapi_server_sdk/types/deep_infra_model_tools_item.rb +159 -0
- data/lib/vapi_server_sdk/types/deepgram_credential.rb +114 -0
- data/lib/vapi_server_sdk/types/deepgram_transcriber.rb +143 -0
- data/lib/vapi_server_sdk/types/deepgram_transcriber_language.rb +62 -0
- data/lib/vapi_server_sdk/types/deepgram_transcriber_model.rb +34 -0
- data/lib/vapi_server_sdk/types/deepgram_voice.rb +96 -0
- data/lib/vapi_server_sdk/types/deepgram_voice_id.rb +53 -0
- data/lib/vapi_server_sdk/types/deepgram_voice_id_enum.rb +18 -0
- data/lib/vapi_server_sdk/types/dtmf_tool.rb +178 -0
- data/lib/vapi_server_sdk/types/dtmf_tool_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/eleven_labs_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/eleven_labs_voice.rb +176 -0
- data/lib/vapi_server_sdk/types/eleven_labs_voice_id.rb +54 -0
- data/lib/vapi_server_sdk/types/eleven_labs_voice_id_enum.rb +21 -0
- data/lib/vapi_server_sdk/types/eleven_labs_voice_model.rb +12 -0
- data/lib/vapi_server_sdk/types/end_call_tool.rb +178 -0
- data/lib/vapi_server_sdk/types/end_call_tool_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/error.rb +55 -0
- data/lib/vapi_server_sdk/types/exact_replacement.rb +65 -0
- data/lib/vapi_server_sdk/types/file.rb +185 -0
- data/lib/vapi_server_sdk/types/file_status.rb +8 -0
- data/lib/vapi_server_sdk/types/format_plan.rb +130 -0
- data/lib/vapi_server_sdk/types/format_plan_replacements_item.rb +94 -0
- data/lib/vapi_server_sdk/types/function_tool.rb +178 -0
- data/lib/vapi_server_sdk/types/function_tool_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/function_tool_provider_details.rb +71 -0
- data/lib/vapi_server_sdk/types/function_tool_with_tool_call.rb +158 -0
- data/lib/vapi_server_sdk/types/function_tool_with_tool_call_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/gcp_credential.rb +138 -0
- data/lib/vapi_server_sdk/types/gcp_key.rb +143 -0
- data/lib/vapi_server_sdk/types/ghl_tool.rb +192 -0
- data/lib/vapi_server_sdk/types/ghl_tool_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/ghl_tool_metadata.rb +67 -0
- data/lib/vapi_server_sdk/types/ghl_tool_provider_details.rb +115 -0
- data/lib/vapi_server_sdk/types/ghl_tool_with_tool_call.rb +173 -0
- data/lib/vapi_server_sdk/types/ghl_tool_with_tool_call_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/gladia_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/gladia_transcriber.rb +122 -0
- data/lib/vapi_server_sdk/types/gladia_transcriber_language.rb +108 -0
- data/lib/vapi_server_sdk/types/gladia_transcriber_language_behaviour.rb +9 -0
- data/lib/vapi_server_sdk/types/gladia_transcriber_model.rb +8 -0
- data/lib/vapi_server_sdk/types/go_high_level_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/groq_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/groq_model.rb +170 -0
- data/lib/vapi_server_sdk/types/groq_model_model.rb +17 -0
- data/lib/vapi_server_sdk/types/groq_model_tools_item.rb +159 -0
- data/lib/vapi_server_sdk/types/handoff_step.rb +204 -0
- data/lib/vapi_server_sdk/types/handoff_step_block.rb +108 -0
- data/lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb +167 -0
- data/lib/vapi_server_sdk/types/import_twilio_phone_number_dto_fallback_destination.rb +101 -0
- data/lib/vapi_server_sdk/types/import_vonage_phone_number_dto.rb +165 -0
- data/lib/vapi_server_sdk/types/import_vonage_phone_number_dto_fallback_destination.rb +101 -0
- data/lib/vapi_server_sdk/types/invite_user_dto.rb +66 -0
- data/lib/vapi_server_sdk/types/invite_user_dto_role.rb +9 -0
- data/lib/vapi_server_sdk/types/json_schema.rb +125 -0
- data/lib/vapi_server_sdk/types/json_schema_type.rb +21 -0
- data/lib/vapi_server_sdk/types/knowledge_base.rb +74 -0
- data/lib/vapi_server_sdk/types/lmnt_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/lmnt_voice.rb +104 -0
- data/lib/vapi_server_sdk/types/lmnt_voice_id.rb +53 -0
- data/lib/vapi_server_sdk/types/lmnt_voice_id_enum.rb +8 -0
- data/lib/vapi_server_sdk/types/log.rb +248 -0
- data/lib/vapi_server_sdk/types/log_request_http_method.rb +12 -0
- data/lib/vapi_server_sdk/types/log_resource.rb +15 -0
- data/lib/vapi_server_sdk/types/log_type.rb +11 -0
- data/lib/vapi_server_sdk/types/logs_paginated_response.rb +75 -0
- data/lib/vapi_server_sdk/types/make_credential.rb +118 -0
- data/lib/vapi_server_sdk/types/make_tool.rb +192 -0
- data/lib/vapi_server_sdk/types/make_tool_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/make_tool_metadata.rb +67 -0
- data/lib/vapi_server_sdk/types/make_tool_provider_details.rb +107 -0
- data/lib/vapi_server_sdk/types/make_tool_with_tool_call.rb +173 -0
- data/lib/vapi_server_sdk/types/make_tool_with_tool_call_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/message_plan.rb +107 -0
- data/lib/vapi_server_sdk/types/metrics.rb +165 -0
- data/lib/vapi_server_sdk/types/model_based_condition.rb +117 -0
- data/lib/vapi_server_sdk/types/model_cost.rb +106 -0
- data/lib/vapi_server_sdk/types/monitor.rb +71 -0
- data/lib/vapi_server_sdk/types/monitor_plan.rb +85 -0
- data/lib/vapi_server_sdk/types/neets_voice.rb +96 -0
- data/lib/vapi_server_sdk/types/neets_voice_id.rb +53 -0
- data/lib/vapi_server_sdk/types/neets_voice_id_enum.rb +7 -0
- data/lib/vapi_server_sdk/types/open_ai_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/open_ai_function.rb +96 -0
- data/lib/vapi_server_sdk/types/open_ai_function_parameters.rb +85 -0
- data/lib/vapi_server_sdk/types/open_ai_message.rb +68 -0
- data/lib/vapi_server_sdk/types/open_ai_message_role.rb +11 -0
- data/lib/vapi_server_sdk/types/open_ai_model.rb +191 -0
- data/lib/vapi_server_sdk/types/open_ai_model_fallback_models_item.rb +23 -0
- data/lib/vapi_server_sdk/types/open_ai_model_model.rb +24 -0
- data/lib/vapi_server_sdk/types/open_ai_model_tools_item.rb +159 -0
- data/lib/vapi_server_sdk/types/open_ai_voice.rb +99 -0
- data/lib/vapi_server_sdk/types/open_ai_voice_id.rb +13 -0
- data/lib/vapi_server_sdk/types/open_router_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/open_router_model.rb +169 -0
- data/lib/vapi_server_sdk/types/open_router_model_tools_item.rb +159 -0
- data/lib/vapi_server_sdk/types/org.rb +212 -0
- data/lib/vapi_server_sdk/types/org_plan.rb +79 -0
- data/lib/vapi_server_sdk/types/output_tool.rb +178 -0
- data/lib/vapi_server_sdk/types/output_tool_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/pagination_meta.rb +72 -0
- data/lib/vapi_server_sdk/types/perplexity_ai_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/perplexity_ai_model.rb +169 -0
- data/lib/vapi_server_sdk/types/perplexity_ai_model_tools_item.rb +159 -0
- data/lib/vapi_server_sdk/types/play_ht_credential.rb +109 -0
- data/lib/vapi_server_sdk/types/play_ht_voice.rb +166 -0
- data/lib/vapi_server_sdk/types/play_ht_voice_emotion.rb +19 -0
- data/lib/vapi_server_sdk/types/play_ht_voice_id.rb +53 -0
- data/lib/vapi_server_sdk/types/play_ht_voice_id_enum.rb +16 -0
- data/lib/vapi_server_sdk/types/punctuation_boundary.rb +21 -0
- data/lib/vapi_server_sdk/types/regex_option.rb +74 -0
- data/lib/vapi_server_sdk/types/regex_option_type.rb +13 -0
- data/lib/vapi_server_sdk/types/regex_replacement.rb +82 -0
- data/lib/vapi_server_sdk/types/rime_ai_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/rime_ai_voice.rb +114 -0
- data/lib/vapi_server_sdk/types/rime_ai_voice_id.rb +53 -0
- data/lib/vapi_server_sdk/types/rime_ai_voice_id_enum.rb +87 -0
- data/lib/vapi_server_sdk/types/rime_ai_voice_model.rb +9 -0
- data/lib/vapi_server_sdk/types/rule_based_condition.rb +195 -0
- data/lib/vapi_server_sdk/types/rule_based_condition_operator.rb +14 -0
- data/lib/vapi_server_sdk/types/runpod_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/s_3_credential.rb +134 -0
- data/lib/vapi_server_sdk/types/sbc_configuration.rb +47 -0
- data/lib/vapi_server_sdk/types/server.rb +82 -0
- data/lib/vapi_server_sdk/types/server_message.rb +77 -0
- data/lib/vapi_server_sdk/types/server_message_assistant_request.rb +169 -0
- data/lib/vapi_server_sdk/types/server_message_assistant_request_phone_number.rb +125 -0
- data/lib/vapi_server_sdk/types/server_message_conversation_update.rb +197 -0
- data/lib/vapi_server_sdk/types/server_message_conversation_update_messages_item.rb +97 -0
- data/lib/vapi_server_sdk/types/server_message_conversation_update_phone_number.rb +125 -0
- data/lib/vapi_server_sdk/types/server_message_end_of_call_report.rb +241 -0
- data/lib/vapi_server_sdk/types/server_message_end_of_call_report_costs_item.rb +147 -0
- data/lib/vapi_server_sdk/types/server_message_end_of_call_report_ended_reason.rb +176 -0
- data/lib/vapi_server_sdk/types/server_message_end_of_call_report_phone_number.rb +125 -0
- data/lib/vapi_server_sdk/types/server_message_hang.rb +169 -0
- data/lib/vapi_server_sdk/types/server_message_hang_phone_number.rb +124 -0
- data/lib/vapi_server_sdk/types/server_message_language_changed.rb +177 -0
- data/lib/vapi_server_sdk/types/server_message_language_changed_phone_number.rb +125 -0
- data/lib/vapi_server_sdk/types/server_message_message.rb +285 -0
- data/lib/vapi_server_sdk/types/server_message_model_output.rb +177 -0
- data/lib/vapi_server_sdk/types/server_message_model_output_phone_number.rb +124 -0
- data/lib/vapi_server_sdk/types/server_message_phone_call_control.rb +192 -0
- data/lib/vapi_server_sdk/types/server_message_phone_call_control_destination.rb +96 -0
- data/lib/vapi_server_sdk/types/server_message_phone_call_control_phone_number.rb +125 -0
- data/lib/vapi_server_sdk/types/server_message_phone_call_control_request.rb +9 -0
- data/lib/vapi_server_sdk/types/server_message_response.rb +65 -0
- data/lib/vapi_server_sdk/types/server_message_response_assistant_request.rb +162 -0
- data/lib/vapi_server_sdk/types/server_message_response_assistant_request_destination.rb +98 -0
- data/lib/vapi_server_sdk/types/server_message_response_message_response.rb +85 -0
- data/lib/vapi_server_sdk/types/server_message_response_tool_calls.rb +71 -0
- data/lib/vapi_server_sdk/types/server_message_response_transfer_destination_request.rb +75 -0
- data/lib/vapi_server_sdk/types/server_message_response_transfer_destination_request_destination.rb +122 -0
- data/lib/vapi_server_sdk/types/server_message_response_voice_request.rb +97 -0
- data/lib/vapi_server_sdk/types/server_message_speech_update.rb +187 -0
- data/lib/vapi_server_sdk/types/server_message_speech_update_phone_number.rb +124 -0
- data/lib/vapi_server_sdk/types/server_message_speech_update_role.rb +9 -0
- data/lib/vapi_server_sdk/types/server_message_speech_update_status.rb +9 -0
- data/lib/vapi_server_sdk/types/server_message_status_update.rb +255 -0
- data/lib/vapi_server_sdk/types/server_message_status_update_destination.rb +96 -0
- data/lib/vapi_server_sdk/types/server_message_status_update_ended_reason.rb +175 -0
- data/lib/vapi_server_sdk/types/server_message_status_update_messages_item.rb +97 -0
- data/lib/vapi_server_sdk/types/server_message_status_update_phone_number.rb +124 -0
- data/lib/vapi_server_sdk/types/server_message_status_update_status.rb +12 -0
- data/lib/vapi_server_sdk/types/server_message_tool_calls.rb +195 -0
- data/lib/vapi_server_sdk/types/server_message_tool_calls_phone_number.rb +124 -0
- data/lib/vapi_server_sdk/types/server_message_tool_calls_tool_with_tool_call_list_item.rb +108 -0
- data/lib/vapi_server_sdk/types/server_message_transcript.rb +195 -0
- data/lib/vapi_server_sdk/types/server_message_transcript_phone_number.rb +124 -0
- data/lib/vapi_server_sdk/types/server_message_transcript_role.rb +9 -0
- data/lib/vapi_server_sdk/types/server_message_transcript_transcript_type.rb +9 -0
- data/lib/vapi_server_sdk/types/server_message_transfer_destination_request.rb +171 -0
- data/lib/vapi_server_sdk/types/server_message_transfer_destination_request_phone_number.rb +125 -0
- data/lib/vapi_server_sdk/types/server_message_transfer_update.rb +213 -0
- data/lib/vapi_server_sdk/types/server_message_transfer_update_destination.rb +122 -0
- data/lib/vapi_server_sdk/types/server_message_transfer_update_phone_number.rb +125 -0
- data/lib/vapi_server_sdk/types/server_message_user_interrupted.rb +169 -0
- data/lib/vapi_server_sdk/types/server_message_user_interrupted_phone_number.rb +125 -0
- data/lib/vapi_server_sdk/types/server_message_voice_input.rb +177 -0
- data/lib/vapi_server_sdk/types/server_message_voice_input_phone_number.rb +124 -0
- data/lib/vapi_server_sdk/types/server_message_voice_request.rb +185 -0
- data/lib/vapi_server_sdk/types/server_message_voice_request_phone_number.rb +124 -0
- data/lib/vapi_server_sdk/types/sip_trunk_gateway.rb +138 -0
- data/lib/vapi_server_sdk/types/sip_trunk_gateway_outbound_protocol.rb +12 -0
- data/lib/vapi_server_sdk/types/sip_trunk_outbound_authentication_plan.rb +86 -0
- data/lib/vapi_server_sdk/types/sip_trunk_outbound_sip_register_plan.rb +74 -0
- data/lib/vapi_server_sdk/types/squad.rb +132 -0
- data/lib/vapi_server_sdk/types/squad_member_dto.rb +113 -0
- data/lib/vapi_server_sdk/types/start_speaking_plan.rb +119 -0
- data/lib/vapi_server_sdk/types/step_destination.rb +82 -0
- data/lib/vapi_server_sdk/types/step_destination_conditions_item.rb +94 -0
- data/lib/vapi_server_sdk/types/stop_speaking_plan.rb +120 -0
- data/lib/vapi_server_sdk/types/structured_data_plan.rb +140 -0
- data/lib/vapi_server_sdk/types/success_evaluation_plan.rb +161 -0
- data/lib/vapi_server_sdk/types/success_evaluation_plan_rubric.rb +29 -0
- data/lib/vapi_server_sdk/types/summary_plan.rb +110 -0
- data/lib/vapi_server_sdk/types/sync_voice_library_dto.rb +58 -0
- data/lib/vapi_server_sdk/types/sync_voice_library_dto_providers_item.rb +16 -0
- data/lib/vapi_server_sdk/types/system_message.rb +79 -0
- data/lib/vapi_server_sdk/types/talkscriber_transcriber.rb +72 -0
- data/lib/vapi_server_sdk/types/talkscriber_transcriber_language.rb +109 -0
- data/lib/vapi_server_sdk/types/template.rb +164 -0
- data/lib/vapi_server_sdk/types/template_details.rb +159 -0
- data/lib/vapi_server_sdk/types/template_provider.rb +9 -0
- data/lib/vapi_server_sdk/types/template_provider_details.rb +107 -0
- data/lib/vapi_server_sdk/types/template_visibility.rb +8 -0
- data/lib/vapi_server_sdk/types/time_range.rb +91 -0
- data/lib/vapi_server_sdk/types/time_range_step.rb +18 -0
- data/lib/vapi_server_sdk/types/together_ai_credential.rb +101 -0
- data/lib/vapi_server_sdk/types/together_ai_model.rb +169 -0
- data/lib/vapi_server_sdk/types/together_ai_model_tools_item.rb +159 -0
- data/lib/vapi_server_sdk/types/token.rb +127 -0
- data/lib/vapi_server_sdk/types/token_restrictions.rb +103 -0
- data/lib/vapi_server_sdk/types/token_tag.rb +9 -0
- data/lib/vapi_server_sdk/types/tool_call.rb +78 -0
- data/lib/vapi_server_sdk/types/tool_call_block.rb +201 -0
- data/lib/vapi_server_sdk/types/tool_call_block_messages_item.rb +94 -0
- data/lib/vapi_server_sdk/types/tool_call_block_tool.rb +161 -0
- data/lib/vapi_server_sdk/types/tool_call_function.rb +65 -0
- data/lib/vapi_server_sdk/types/tool_call_message.rb +92 -0
- data/lib/vapi_server_sdk/types/tool_call_result.rb +126 -0
- data/lib/vapi_server_sdk/types/tool_call_result_message.rb +100 -0
- data/lib/vapi_server_sdk/types/tool_call_result_message_item.rb +94 -0
- data/lib/vapi_server_sdk/types/tool_message_complete.rb +130 -0
- data/lib/vapi_server_sdk/types/tool_message_complete_role.rb +24 -0
- data/lib/vapi_server_sdk/types/tool_message_delayed.rb +86 -0
- data/lib/vapi_server_sdk/types/tool_message_failed.rb +88 -0
- data/lib/vapi_server_sdk/types/tool_message_start.rb +73 -0
- data/lib/vapi_server_sdk/types/tool_template_metadata.rb +78 -0
- data/lib/vapi_server_sdk/types/tool_template_setup.rb +86 -0
- data/lib/vapi_server_sdk/types/transcriber_cost.rb +90 -0
- data/lib/vapi_server_sdk/types/transcript_plan.rb +122 -0
- data/lib/vapi_server_sdk/types/transcription_endpointing_plan.rb +109 -0
- data/lib/vapi_server_sdk/types/transfer_call_tool.rb +194 -0
- data/lib/vapi_server_sdk/types/transfer_call_tool_destinations_item.rb +120 -0
- data/lib/vapi_server_sdk/types/transfer_call_tool_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/transfer_destination_assistant.rb +181 -0
- data/lib/vapi_server_sdk/types/transfer_destination_number.rb +163 -0
- data/lib/vapi_server_sdk/types/transfer_destination_sip.rb +90 -0
- data/lib/vapi_server_sdk/types/transfer_destination_step.rb +90 -0
- data/lib/vapi_server_sdk/types/transfer_mode.rb +8 -0
- data/lib/vapi_server_sdk/types/transport_configuration_twilio.rb +125 -0
- data/lib/vapi_server_sdk/types/transport_configuration_twilio_recording_channels.rb +16 -0
- data/lib/vapi_server_sdk/types/transport_cost.rb +67 -0
- data/lib/vapi_server_sdk/types/twilio_credential.rb +110 -0
- data/lib/vapi_server_sdk/types/twilio_phone_number.rb +200 -0
- data/lib/vapi_server_sdk/types/twilio_phone_number_fallback_destination.rb +100 -0
- data/lib/vapi_server_sdk/types/twilio_voicemail_detection.rb +248 -0
- data/lib/vapi_server_sdk/types/twilio_voicemail_detection_voicemail_detection_types_item.rb +13 -0
- data/lib/vapi_server_sdk/types/update_anthropic_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_anyscale_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto.rb +94 -0
- data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto_models_item.rb +14 -0
- data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto_region.rb +21 -0
- data/lib/vapi_server_sdk/types/update_byo_sip_trunk_credential_dto.rb +133 -0
- data/lib/vapi_server_sdk/types/update_cartesia_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_custom_llm_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_deep_infra_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_deepgram_credential_dto.rb +76 -0
- data/lib/vapi_server_sdk/types/update_eleven_labs_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_gcp_credential_dto.rb +104 -0
- data/lib/vapi_server_sdk/types/update_gladia_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_go_high_level_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_groq_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_lmnt_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_make_credential_dto.rb +79 -0
- data/lib/vapi_server_sdk/types/update_open_ai_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_open_router_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_org_dto.rb +129 -0
- data/lib/vapi_server_sdk/types/update_perplexity_ai_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_play_ht_credential_dto.rb +72 -0
- data/lib/vapi_server_sdk/types/update_rime_ai_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_runpod_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_s_3_credential_dto.rb +101 -0
- data/lib/vapi_server_sdk/types/update_together_ai_credential_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/update_tool_template_dto.rb +131 -0
- data/lib/vapi_server_sdk/types/update_tool_template_dto_details.rb +159 -0
- data/lib/vapi_server_sdk/types/update_tool_template_dto_provider.rb +9 -0
- data/lib/vapi_server_sdk/types/update_tool_template_dto_provider_details.rb +107 -0
- data/lib/vapi_server_sdk/types/update_tool_template_dto_visibility.rb +8 -0
- data/lib/vapi_server_sdk/types/update_twilio_credential_dto.rb +72 -0
- data/lib/vapi_server_sdk/types/update_user_role_dto.rb +66 -0
- data/lib/vapi_server_sdk/types/update_user_role_dto_role.rb +9 -0
- data/lib/vapi_server_sdk/types/update_vonage_credential_dto.rb +72 -0
- data/lib/vapi_server_sdk/types/user.rb +95 -0
- data/lib/vapi_server_sdk/types/user_message.rb +102 -0
- data/lib/vapi_server_sdk/types/vapi_cost.rb +67 -0
- data/lib/vapi_server_sdk/types/vapi_model.rb +181 -0
- data/lib/vapi_server_sdk/types/vapi_model_steps_item.rb +94 -0
- data/lib/vapi_server_sdk/types/vapi_model_tools_item.rb +159 -0
- data/lib/vapi_server_sdk/types/vapi_phone_number.rb +188 -0
- data/lib/vapi_server_sdk/types/vapi_phone_number_fallback_destination.rb +100 -0
- data/lib/vapi_server_sdk/types/voice_cost.rb +90 -0
- data/lib/vapi_server_sdk/types/voice_library.rb +209 -0
- data/lib/vapi_server_sdk/types/voice_library_gender.rb +9 -0
- data/lib/vapi_server_sdk/types/voice_library_voice_response.rb +111 -0
- data/lib/vapi_server_sdk/types/vonage_credential.rb +128 -0
- data/lib/vapi_server_sdk/types/vonage_phone_number.rb +194 -0
- data/lib/vapi_server_sdk/types/vonage_phone_number_fallback_destination.rb +100 -0
- data/lib/vapi_server_sdk/types/workflow_block.rb +187 -0
- data/lib/vapi_server_sdk/types/workflow_block_messages_item.rb +94 -0
- data/lib/vapi_server_sdk/types/workflow_block_steps_item.rb +94 -0
- data/lib/vapi_server_sdk.rb +110 -0
- metadata +697 -0
@@ -0,0 +1,1050 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "../../requests"
|
4
|
+
require "date"
|
5
|
+
require_relative "../types/squad"
|
6
|
+
require "json"
|
7
|
+
require_relative "../types/create_squad_dto"
|
8
|
+
require_relative "../types/squad_member_dto"
|
9
|
+
require_relative "../types/assistant_overrides"
|
10
|
+
require "async"
|
11
|
+
|
12
|
+
module Vapi
|
13
|
+
class SquadsClient
|
14
|
+
# @return [Vapi::RequestClient]
|
15
|
+
attr_reader :request_client
|
16
|
+
|
17
|
+
# @param request_client [Vapi::RequestClient]
|
18
|
+
# @return [Vapi::SquadsClient]
|
19
|
+
def initialize(request_client:)
|
20
|
+
@request_client = request_client
|
21
|
+
end
|
22
|
+
|
23
|
+
# @param limit [Float] This is the maximum number of items to return. Defaults to 100.
|
24
|
+
# @param created_at_gt [DateTime] This will return items where the createdAt is greater than the specified value.
|
25
|
+
# @param created_at_lt [DateTime] This will return items where the createdAt is less than the specified value.
|
26
|
+
# @param created_at_ge [DateTime] This will return items where the createdAt is greater than or equal to the
|
27
|
+
# specified value.
|
28
|
+
# @param created_at_le [DateTime] This will return items where the createdAt is less than or equal to the
|
29
|
+
# specified value.
|
30
|
+
# @param updated_at_gt [DateTime] This will return items where the updatedAt is greater than the specified value.
|
31
|
+
# @param updated_at_lt [DateTime] This will return items where the updatedAt is less than the specified value.
|
32
|
+
# @param updated_at_ge [DateTime] This will return items where the updatedAt is greater than or equal to the
|
33
|
+
# specified value.
|
34
|
+
# @param updated_at_le [DateTime] This will return items where the updatedAt is less than or equal to the
|
35
|
+
# specified value.
|
36
|
+
# @param request_options [Vapi::RequestOptions]
|
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
|
+
def list(limit: nil, created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil,
|
46
|
+
updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
|
47
|
+
response = @request_client.conn.get do |req|
|
48
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
49
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
50
|
+
req.headers = {
|
51
|
+
**(req.headers || {}),
|
52
|
+
**@request_client.get_headers,
|
53
|
+
**(request_options&.additional_headers || {})
|
54
|
+
}.compact
|
55
|
+
req.params = {
|
56
|
+
**(request_options&.additional_query_parameters || {}),
|
57
|
+
"limit": limit,
|
58
|
+
"createdAtGt": created_at_gt,
|
59
|
+
"createdAtLt": created_at_lt,
|
60
|
+
"createdAtGe": created_at_ge,
|
61
|
+
"createdAtLe": created_at_le,
|
62
|
+
"updatedAtGt": updated_at_gt,
|
63
|
+
"updatedAtLt": updated_at_lt,
|
64
|
+
"updatedAtGe": updated_at_ge,
|
65
|
+
"updatedAtLe": updated_at_le
|
66
|
+
}.compact
|
67
|
+
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
68
|
+
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
|
69
|
+
end
|
70
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/squad"
|
71
|
+
end
|
72
|
+
parsed_json = JSON.parse(response.body)
|
73
|
+
parsed_json&.map do |item|
|
74
|
+
item = item.to_json
|
75
|
+
Vapi::Squad.from_json(json_object: item)
|
76
|
+
end
|
77
|
+
end
|
78
|
+
|
79
|
+
# @param request [Hash] Request of type Vapi::CreateSquadDto, as a Hash
|
80
|
+
# * :name (String)
|
81
|
+
# * :members (Array<Vapi::SquadMemberDto>)
|
82
|
+
# * :members_overrides (Hash)
|
83
|
+
# * :transcriber (Hash)
|
84
|
+
# * :model (Hash)
|
85
|
+
# * :voice (Hash)
|
86
|
+
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
87
|
+
# * :hipaa_enabled (Boolean)
|
88
|
+
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
89
|
+
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
90
|
+
# * :silence_timeout_seconds (Float)
|
91
|
+
# * :max_duration_seconds (Float)
|
92
|
+
# * :background_sound (Vapi::AssistantOverridesBackgroundSound)
|
93
|
+
# * :backchanneling_enabled (Boolean)
|
94
|
+
# * :background_denoising_enabled (Boolean)
|
95
|
+
# * :model_output_in_messages_enabled (Boolean)
|
96
|
+
# * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
|
97
|
+
# * :variable_values (Hash{String => Object})
|
98
|
+
# * :name (String)
|
99
|
+
# * :first_message (String)
|
100
|
+
# * :voicemail_detection (Hash)
|
101
|
+
# * :provider (String)
|
102
|
+
# * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
|
103
|
+
# * :enabled (Boolean)
|
104
|
+
# * :machine_detection_timeout (Float)
|
105
|
+
# * :machine_detection_speech_threshold (Float)
|
106
|
+
# * :machine_detection_speech_end_threshold (Float)
|
107
|
+
# * :machine_detection_silence_timeout (Float)
|
108
|
+
# * :voicemail_message (String)
|
109
|
+
# * :end_call_message (String)
|
110
|
+
# * :end_call_phrases (Array<String>)
|
111
|
+
# * :metadata (Hash{String => Object})
|
112
|
+
# * :server_url (String)
|
113
|
+
# * :server_url_secret (String)
|
114
|
+
# * :analysis_plan (Hash)
|
115
|
+
# * :summary_plan (Hash)
|
116
|
+
# * :messages (Array<Hash{String => Object}>)
|
117
|
+
# * :enabled (Boolean)
|
118
|
+
# * :timeout_seconds (Float)
|
119
|
+
# * :structured_data_plan (Hash)
|
120
|
+
# * :messages (Array<Hash{String => Object}>)
|
121
|
+
# * :enabled (Boolean)
|
122
|
+
# * :schema (Hash)
|
123
|
+
# * :type (Vapi::JsonSchemaType)
|
124
|
+
# * :items (Hash{String => Object})
|
125
|
+
# * :properties (Hash{String => Object})
|
126
|
+
# * :description (String)
|
127
|
+
# * :required (Array<String>)
|
128
|
+
# * :timeout_seconds (Float)
|
129
|
+
# * :success_evaluation_plan (Hash)
|
130
|
+
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
131
|
+
# * :messages (Array<Hash{String => Object}>)
|
132
|
+
# * :enabled (Boolean)
|
133
|
+
# * :timeout_seconds (Float)
|
134
|
+
# * :artifact_plan (Hash)
|
135
|
+
# * :recording_enabled (Boolean)
|
136
|
+
# * :video_recording_enabled (Boolean)
|
137
|
+
# * :transcript_plan (Hash)
|
138
|
+
# * :enabled (Boolean)
|
139
|
+
# * :assistant_name (String)
|
140
|
+
# * :user_name (String)
|
141
|
+
# * :recording_path (String)
|
142
|
+
# * :message_plan (Hash)
|
143
|
+
# * :idle_messages (Array<String>)
|
144
|
+
# * :idle_message_max_spoken_count (Float)
|
145
|
+
# * :idle_timeout_seconds (Float)
|
146
|
+
# * :start_speaking_plan (Hash)
|
147
|
+
# * :wait_seconds (Float)
|
148
|
+
# * :smart_endpointing_enabled (Boolean)
|
149
|
+
# * :transcription_endpointing_plan (Hash)
|
150
|
+
# * :on_punctuation_seconds (Float)
|
151
|
+
# * :on_no_punctuation_seconds (Float)
|
152
|
+
# * :on_number_seconds (Float)
|
153
|
+
# * :stop_speaking_plan (Hash)
|
154
|
+
# * :num_words (Float)
|
155
|
+
# * :voice_seconds (Float)
|
156
|
+
# * :backoff_seconds (Float)
|
157
|
+
# * :monitor_plan (Hash)
|
158
|
+
# * :listen_enabled (Boolean)
|
159
|
+
# * :control_enabled (Boolean)
|
160
|
+
# * :credential_ids (Array<String>)
|
161
|
+
# @param request_options [Vapi::RequestOptions]
|
162
|
+
# @return [Vapi::Squad]
|
163
|
+
# @example
|
164
|
+
# api = Vapi::Client.new(
|
165
|
+
# base_url: "https://api.example.com",
|
166
|
+
# environment: Vapi::Environment::DEFAULT,
|
167
|
+
# token: "YOUR_AUTH_TOKEN"
|
168
|
+
# )
|
169
|
+
# api.squads.create(request: { members: [{ }] })
|
170
|
+
def create(request:, request_options: nil)
|
171
|
+
response = @request_client.conn.post do |req|
|
172
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
173
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
174
|
+
req.headers = {
|
175
|
+
**(req.headers || {}),
|
176
|
+
**@request_client.get_headers,
|
177
|
+
**(request_options&.additional_headers || {})
|
178
|
+
}.compact
|
179
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
180
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
181
|
+
end
|
182
|
+
req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
|
183
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/squad"
|
184
|
+
end
|
185
|
+
Vapi::Squad.from_json(json_object: response.body)
|
186
|
+
end
|
187
|
+
|
188
|
+
# @param id [String]
|
189
|
+
# @param request_options [Vapi::RequestOptions]
|
190
|
+
# @return [Vapi::Squad]
|
191
|
+
# @example
|
192
|
+
# api = Vapi::Client.new(
|
193
|
+
# base_url: "https://api.example.com",
|
194
|
+
# environment: Vapi::Environment::DEFAULT,
|
195
|
+
# token: "YOUR_AUTH_TOKEN"
|
196
|
+
# )
|
197
|
+
# api.squads.get(id: "id")
|
198
|
+
def get(id:, request_options: nil)
|
199
|
+
response = @request_client.conn.get do |req|
|
200
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
201
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
202
|
+
req.headers = {
|
203
|
+
**(req.headers || {}),
|
204
|
+
**@request_client.get_headers,
|
205
|
+
**(request_options&.additional_headers || {})
|
206
|
+
}.compact
|
207
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
208
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
209
|
+
end
|
210
|
+
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
211
|
+
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
|
212
|
+
end
|
213
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/squad/#{id}"
|
214
|
+
end
|
215
|
+
Vapi::Squad.from_json(json_object: response.body)
|
216
|
+
end
|
217
|
+
|
218
|
+
# @param id [String]
|
219
|
+
# @param request_options [Vapi::RequestOptions]
|
220
|
+
# @return [Vapi::Squad]
|
221
|
+
# @example
|
222
|
+
# api = Vapi::Client.new(
|
223
|
+
# base_url: "https://api.example.com",
|
224
|
+
# environment: Vapi::Environment::DEFAULT,
|
225
|
+
# token: "YOUR_AUTH_TOKEN"
|
226
|
+
# )
|
227
|
+
# api.squads.delete(id: "id")
|
228
|
+
def delete(id:, request_options: nil)
|
229
|
+
response = @request_client.conn.delete do |req|
|
230
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
231
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
232
|
+
req.headers = {
|
233
|
+
**(req.headers || {}),
|
234
|
+
**@request_client.get_headers,
|
235
|
+
**(request_options&.additional_headers || {})
|
236
|
+
}.compact
|
237
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
238
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
239
|
+
end
|
240
|
+
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
241
|
+
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
|
242
|
+
end
|
243
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/squad/#{id}"
|
244
|
+
end
|
245
|
+
Vapi::Squad.from_json(json_object: response.body)
|
246
|
+
end
|
247
|
+
|
248
|
+
# @param id [String]
|
249
|
+
# @param name [String] This is the name of the squad.
|
250
|
+
# @param members [Array<Hash>] This is the list of assistants that make up the squad.
|
251
|
+
# The call will start with the first assistant in the list.Request of type Array<Vapi::SquadMemberDto>, as a Hash
|
252
|
+
# * :assistant_id (String)
|
253
|
+
# * :assistant (Hash)
|
254
|
+
# * :transcriber (Hash)
|
255
|
+
# * :model (Hash)
|
256
|
+
# * :voice (Hash)
|
257
|
+
# * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
|
258
|
+
# * :hipaa_enabled (Boolean)
|
259
|
+
# * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
|
260
|
+
# * :server_messages (Array<Vapi::CreateAssistantDtoServerMessagesItem>)
|
261
|
+
# * :silence_timeout_seconds (Float)
|
262
|
+
# * :max_duration_seconds (Float)
|
263
|
+
# * :background_sound (Vapi::CreateAssistantDtoBackgroundSound)
|
264
|
+
# * :backchanneling_enabled (Boolean)
|
265
|
+
# * :background_denoising_enabled (Boolean)
|
266
|
+
# * :model_output_in_messages_enabled (Boolean)
|
267
|
+
# * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
|
268
|
+
# * :name (String)
|
269
|
+
# * :first_message (String)
|
270
|
+
# * :voicemail_detection (Hash)
|
271
|
+
# * :provider (String)
|
272
|
+
# * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
|
273
|
+
# * :enabled (Boolean)
|
274
|
+
# * :machine_detection_timeout (Float)
|
275
|
+
# * :machine_detection_speech_threshold (Float)
|
276
|
+
# * :machine_detection_speech_end_threshold (Float)
|
277
|
+
# * :machine_detection_silence_timeout (Float)
|
278
|
+
# * :voicemail_message (String)
|
279
|
+
# * :end_call_message (String)
|
280
|
+
# * :end_call_phrases (Array<String>)
|
281
|
+
# * :metadata (Hash{String => Object})
|
282
|
+
# * :server_url (String)
|
283
|
+
# * :server_url_secret (String)
|
284
|
+
# * :analysis_plan (Hash)
|
285
|
+
# * :summary_plan (Hash)
|
286
|
+
# * :messages (Array<Hash{String => Object}>)
|
287
|
+
# * :enabled (Boolean)
|
288
|
+
# * :timeout_seconds (Float)
|
289
|
+
# * :structured_data_plan (Hash)
|
290
|
+
# * :messages (Array<Hash{String => Object}>)
|
291
|
+
# * :enabled (Boolean)
|
292
|
+
# * :schema (Hash)
|
293
|
+
# * :type (Vapi::JsonSchemaType)
|
294
|
+
# * :items (Hash{String => Object})
|
295
|
+
# * :properties (Hash{String => Object})
|
296
|
+
# * :description (String)
|
297
|
+
# * :required (Array<String>)
|
298
|
+
# * :timeout_seconds (Float)
|
299
|
+
# * :success_evaluation_plan (Hash)
|
300
|
+
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
301
|
+
# * :messages (Array<Hash{String => Object}>)
|
302
|
+
# * :enabled (Boolean)
|
303
|
+
# * :timeout_seconds (Float)
|
304
|
+
# * :artifact_plan (Hash)
|
305
|
+
# * :recording_enabled (Boolean)
|
306
|
+
# * :video_recording_enabled (Boolean)
|
307
|
+
# * :transcript_plan (Hash)
|
308
|
+
# * :enabled (Boolean)
|
309
|
+
# * :assistant_name (String)
|
310
|
+
# * :user_name (String)
|
311
|
+
# * :recording_path (String)
|
312
|
+
# * :message_plan (Hash)
|
313
|
+
# * :idle_messages (Array<String>)
|
314
|
+
# * :idle_message_max_spoken_count (Float)
|
315
|
+
# * :idle_timeout_seconds (Float)
|
316
|
+
# * :start_speaking_plan (Hash)
|
317
|
+
# * :wait_seconds (Float)
|
318
|
+
# * :smart_endpointing_enabled (Boolean)
|
319
|
+
# * :transcription_endpointing_plan (Hash)
|
320
|
+
# * :on_punctuation_seconds (Float)
|
321
|
+
# * :on_no_punctuation_seconds (Float)
|
322
|
+
# * :on_number_seconds (Float)
|
323
|
+
# * :stop_speaking_plan (Hash)
|
324
|
+
# * :num_words (Float)
|
325
|
+
# * :voice_seconds (Float)
|
326
|
+
# * :backoff_seconds (Float)
|
327
|
+
# * :monitor_plan (Hash)
|
328
|
+
# * :listen_enabled (Boolean)
|
329
|
+
# * :control_enabled (Boolean)
|
330
|
+
# * :credential_ids (Array<String>)
|
331
|
+
# * :assistant_overrides (Hash)
|
332
|
+
# * :transcriber (Hash)
|
333
|
+
# * :model (Hash)
|
334
|
+
# * :voice (Hash)
|
335
|
+
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
336
|
+
# * :hipaa_enabled (Boolean)
|
337
|
+
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
338
|
+
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
339
|
+
# * :silence_timeout_seconds (Float)
|
340
|
+
# * :max_duration_seconds (Float)
|
341
|
+
# * :background_sound (Vapi::AssistantOverridesBackgroundSound)
|
342
|
+
# * :backchanneling_enabled (Boolean)
|
343
|
+
# * :background_denoising_enabled (Boolean)
|
344
|
+
# * :model_output_in_messages_enabled (Boolean)
|
345
|
+
# * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
|
346
|
+
# * :variable_values (Hash{String => Object})
|
347
|
+
# * :name (String)
|
348
|
+
# * :first_message (String)
|
349
|
+
# * :voicemail_detection (Hash)
|
350
|
+
# * :provider (String)
|
351
|
+
# * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
|
352
|
+
# * :enabled (Boolean)
|
353
|
+
# * :machine_detection_timeout (Float)
|
354
|
+
# * :machine_detection_speech_threshold (Float)
|
355
|
+
# * :machine_detection_speech_end_threshold (Float)
|
356
|
+
# * :machine_detection_silence_timeout (Float)
|
357
|
+
# * :voicemail_message (String)
|
358
|
+
# * :end_call_message (String)
|
359
|
+
# * :end_call_phrases (Array<String>)
|
360
|
+
# * :metadata (Hash{String => Object})
|
361
|
+
# * :server_url (String)
|
362
|
+
# * :server_url_secret (String)
|
363
|
+
# * :analysis_plan (Hash)
|
364
|
+
# * :summary_plan (Hash)
|
365
|
+
# * :messages (Array<Hash{String => Object}>)
|
366
|
+
# * :enabled (Boolean)
|
367
|
+
# * :timeout_seconds (Float)
|
368
|
+
# * :structured_data_plan (Hash)
|
369
|
+
# * :messages (Array<Hash{String => Object}>)
|
370
|
+
# * :enabled (Boolean)
|
371
|
+
# * :schema (Hash)
|
372
|
+
# * :type (Vapi::JsonSchemaType)
|
373
|
+
# * :items (Hash{String => Object})
|
374
|
+
# * :properties (Hash{String => Object})
|
375
|
+
# * :description (String)
|
376
|
+
# * :required (Array<String>)
|
377
|
+
# * :timeout_seconds (Float)
|
378
|
+
# * :success_evaluation_plan (Hash)
|
379
|
+
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
380
|
+
# * :messages (Array<Hash{String => Object}>)
|
381
|
+
# * :enabled (Boolean)
|
382
|
+
# * :timeout_seconds (Float)
|
383
|
+
# * :artifact_plan (Hash)
|
384
|
+
# * :recording_enabled (Boolean)
|
385
|
+
# * :video_recording_enabled (Boolean)
|
386
|
+
# * :transcript_plan (Hash)
|
387
|
+
# * :enabled (Boolean)
|
388
|
+
# * :assistant_name (String)
|
389
|
+
# * :user_name (String)
|
390
|
+
# * :recording_path (String)
|
391
|
+
# * :message_plan (Hash)
|
392
|
+
# * :idle_messages (Array<String>)
|
393
|
+
# * :idle_message_max_spoken_count (Float)
|
394
|
+
# * :idle_timeout_seconds (Float)
|
395
|
+
# * :start_speaking_plan (Hash)
|
396
|
+
# * :wait_seconds (Float)
|
397
|
+
# * :smart_endpointing_enabled (Boolean)
|
398
|
+
# * :transcription_endpointing_plan (Hash)
|
399
|
+
# * :on_punctuation_seconds (Float)
|
400
|
+
# * :on_no_punctuation_seconds (Float)
|
401
|
+
# * :on_number_seconds (Float)
|
402
|
+
# * :stop_speaking_plan (Hash)
|
403
|
+
# * :num_words (Float)
|
404
|
+
# * :voice_seconds (Float)
|
405
|
+
# * :backoff_seconds (Float)
|
406
|
+
# * :monitor_plan (Hash)
|
407
|
+
# * :listen_enabled (Boolean)
|
408
|
+
# * :control_enabled (Boolean)
|
409
|
+
# * :credential_ids (Array<String>)
|
410
|
+
# * :assistant_destinations (Array<Vapi::TransferDestinationAssistant>)
|
411
|
+
# @param members_overrides [Hash] This can be used to override all the assistants' settings and provide values for
|
412
|
+
# their template variables.
|
413
|
+
# Both `membersOverrides` and `members[n].assistantOverrides` can be used
|
414
|
+
# together. First, `members[n].assistantOverrides` is applied. Then,
|
415
|
+
# `membersOverrides` is applied as a global override.Request of type Vapi::AssistantOverrides, as a Hash
|
416
|
+
# * :transcriber (Hash)
|
417
|
+
# * :model (Hash)
|
418
|
+
# * :voice (Hash)
|
419
|
+
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
420
|
+
# * :hipaa_enabled (Boolean)
|
421
|
+
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
422
|
+
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
423
|
+
# * :silence_timeout_seconds (Float)
|
424
|
+
# * :max_duration_seconds (Float)
|
425
|
+
# * :background_sound (Vapi::AssistantOverridesBackgroundSound)
|
426
|
+
# * :backchanneling_enabled (Boolean)
|
427
|
+
# * :background_denoising_enabled (Boolean)
|
428
|
+
# * :model_output_in_messages_enabled (Boolean)
|
429
|
+
# * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
|
430
|
+
# * :variable_values (Hash{String => Object})
|
431
|
+
# * :name (String)
|
432
|
+
# * :first_message (String)
|
433
|
+
# * :voicemail_detection (Hash)
|
434
|
+
# * :provider (String)
|
435
|
+
# * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
|
436
|
+
# * :enabled (Boolean)
|
437
|
+
# * :machine_detection_timeout (Float)
|
438
|
+
# * :machine_detection_speech_threshold (Float)
|
439
|
+
# * :machine_detection_speech_end_threshold (Float)
|
440
|
+
# * :machine_detection_silence_timeout (Float)
|
441
|
+
# * :voicemail_message (String)
|
442
|
+
# * :end_call_message (String)
|
443
|
+
# * :end_call_phrases (Array<String>)
|
444
|
+
# * :metadata (Hash{String => Object})
|
445
|
+
# * :server_url (String)
|
446
|
+
# * :server_url_secret (String)
|
447
|
+
# * :analysis_plan (Hash)
|
448
|
+
# * :summary_plan (Hash)
|
449
|
+
# * :messages (Array<Hash{String => Object}>)
|
450
|
+
# * :enabled (Boolean)
|
451
|
+
# * :timeout_seconds (Float)
|
452
|
+
# * :structured_data_plan (Hash)
|
453
|
+
# * :messages (Array<Hash{String => Object}>)
|
454
|
+
# * :enabled (Boolean)
|
455
|
+
# * :schema (Hash)
|
456
|
+
# * :type (Vapi::JsonSchemaType)
|
457
|
+
# * :items (Hash{String => Object})
|
458
|
+
# * :properties (Hash{String => Object})
|
459
|
+
# * :description (String)
|
460
|
+
# * :required (Array<String>)
|
461
|
+
# * :timeout_seconds (Float)
|
462
|
+
# * :success_evaluation_plan (Hash)
|
463
|
+
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
464
|
+
# * :messages (Array<Hash{String => Object}>)
|
465
|
+
# * :enabled (Boolean)
|
466
|
+
# * :timeout_seconds (Float)
|
467
|
+
# * :artifact_plan (Hash)
|
468
|
+
# * :recording_enabled (Boolean)
|
469
|
+
# * :video_recording_enabled (Boolean)
|
470
|
+
# * :transcript_plan (Hash)
|
471
|
+
# * :enabled (Boolean)
|
472
|
+
# * :assistant_name (String)
|
473
|
+
# * :user_name (String)
|
474
|
+
# * :recording_path (String)
|
475
|
+
# * :message_plan (Hash)
|
476
|
+
# * :idle_messages (Array<String>)
|
477
|
+
# * :idle_message_max_spoken_count (Float)
|
478
|
+
# * :idle_timeout_seconds (Float)
|
479
|
+
# * :start_speaking_plan (Hash)
|
480
|
+
# * :wait_seconds (Float)
|
481
|
+
# * :smart_endpointing_enabled (Boolean)
|
482
|
+
# * :transcription_endpointing_plan (Hash)
|
483
|
+
# * :on_punctuation_seconds (Float)
|
484
|
+
# * :on_no_punctuation_seconds (Float)
|
485
|
+
# * :on_number_seconds (Float)
|
486
|
+
# * :stop_speaking_plan (Hash)
|
487
|
+
# * :num_words (Float)
|
488
|
+
# * :voice_seconds (Float)
|
489
|
+
# * :backoff_seconds (Float)
|
490
|
+
# * :monitor_plan (Hash)
|
491
|
+
# * :listen_enabled (Boolean)
|
492
|
+
# * :control_enabled (Boolean)
|
493
|
+
# * :credential_ids (Array<String>)
|
494
|
+
# @param request_options [Vapi::RequestOptions]
|
495
|
+
# @return [Vapi::Squad]
|
496
|
+
# @example
|
497
|
+
# api = Vapi::Client.new(
|
498
|
+
# base_url: "https://api.example.com",
|
499
|
+
# environment: Vapi::Environment::DEFAULT,
|
500
|
+
# token: "YOUR_AUTH_TOKEN"
|
501
|
+
# )
|
502
|
+
# api.squads.update(id: "id", members: [{ }])
|
503
|
+
def update(id:, members:, name: nil, members_overrides: nil, request_options: nil)
|
504
|
+
response = @request_client.conn.patch do |req|
|
505
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
506
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
507
|
+
req.headers = {
|
508
|
+
**(req.headers || {}),
|
509
|
+
**@request_client.get_headers,
|
510
|
+
**(request_options&.additional_headers || {})
|
511
|
+
}.compact
|
512
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
513
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
514
|
+
end
|
515
|
+
req.body = {
|
516
|
+
**(request_options&.additional_body_parameters || {}),
|
517
|
+
name: name,
|
518
|
+
members: members,
|
519
|
+
membersOverrides: members_overrides
|
520
|
+
}.compact
|
521
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/squad/#{id}"
|
522
|
+
end
|
523
|
+
Vapi::Squad.from_json(json_object: response.body)
|
524
|
+
end
|
525
|
+
end
|
526
|
+
|
527
|
+
class AsyncSquadsClient
|
528
|
+
# @return [Vapi::AsyncRequestClient]
|
529
|
+
attr_reader :request_client
|
530
|
+
|
531
|
+
# @param request_client [Vapi::AsyncRequestClient]
|
532
|
+
# @return [Vapi::AsyncSquadsClient]
|
533
|
+
def initialize(request_client:)
|
534
|
+
@request_client = request_client
|
535
|
+
end
|
536
|
+
|
537
|
+
# @param limit [Float] This is the maximum number of items to return. Defaults to 100.
|
538
|
+
# @param created_at_gt [DateTime] This will return items where the createdAt is greater than the specified value.
|
539
|
+
# @param created_at_lt [DateTime] This will return items where the createdAt is less than the specified value.
|
540
|
+
# @param created_at_ge [DateTime] This will return items where the createdAt is greater than or equal to the
|
541
|
+
# specified value.
|
542
|
+
# @param created_at_le [DateTime] This will return items where the createdAt is less than or equal to the
|
543
|
+
# specified value.
|
544
|
+
# @param updated_at_gt [DateTime] This will return items where the updatedAt is greater than the specified value.
|
545
|
+
# @param updated_at_lt [DateTime] This will return items where the updatedAt is less than the specified value.
|
546
|
+
# @param updated_at_ge [DateTime] This will return items where the updatedAt is greater than or equal to the
|
547
|
+
# specified value.
|
548
|
+
# @param updated_at_le [DateTime] This will return items where the updatedAt is less than or equal to the
|
549
|
+
# specified value.
|
550
|
+
# @param request_options [Vapi::RequestOptions]
|
551
|
+
# @return [Array<Vapi::Squad>]
|
552
|
+
# @example
|
553
|
+
# api = Vapi::Client.new(
|
554
|
+
# base_url: "https://api.example.com",
|
555
|
+
# environment: Vapi::Environment::DEFAULT,
|
556
|
+
# token: "YOUR_AUTH_TOKEN"
|
557
|
+
# )
|
558
|
+
# api.squads.list
|
559
|
+
def list(limit: nil, created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil,
|
560
|
+
updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
|
561
|
+
Async do
|
562
|
+
response = @request_client.conn.get do |req|
|
563
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
564
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
565
|
+
req.headers = {
|
566
|
+
**(req.headers || {}),
|
567
|
+
**@request_client.get_headers,
|
568
|
+
**(request_options&.additional_headers || {})
|
569
|
+
}.compact
|
570
|
+
req.params = {
|
571
|
+
**(request_options&.additional_query_parameters || {}),
|
572
|
+
"limit": limit,
|
573
|
+
"createdAtGt": created_at_gt,
|
574
|
+
"createdAtLt": created_at_lt,
|
575
|
+
"createdAtGe": created_at_ge,
|
576
|
+
"createdAtLe": created_at_le,
|
577
|
+
"updatedAtGt": updated_at_gt,
|
578
|
+
"updatedAtLt": updated_at_lt,
|
579
|
+
"updatedAtGe": updated_at_ge,
|
580
|
+
"updatedAtLe": updated_at_le
|
581
|
+
}.compact
|
582
|
+
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
583
|
+
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
|
584
|
+
end
|
585
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/squad"
|
586
|
+
end
|
587
|
+
parsed_json = JSON.parse(response.body)
|
588
|
+
parsed_json&.map do |item|
|
589
|
+
item = item.to_json
|
590
|
+
Vapi::Squad.from_json(json_object: item)
|
591
|
+
end
|
592
|
+
end
|
593
|
+
end
|
594
|
+
|
595
|
+
# @param request [Hash] Request of type Vapi::CreateSquadDto, as a Hash
|
596
|
+
# * :name (String)
|
597
|
+
# * :members (Array<Vapi::SquadMemberDto>)
|
598
|
+
# * :members_overrides (Hash)
|
599
|
+
# * :transcriber (Hash)
|
600
|
+
# * :model (Hash)
|
601
|
+
# * :voice (Hash)
|
602
|
+
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
603
|
+
# * :hipaa_enabled (Boolean)
|
604
|
+
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
605
|
+
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
606
|
+
# * :silence_timeout_seconds (Float)
|
607
|
+
# * :max_duration_seconds (Float)
|
608
|
+
# * :background_sound (Vapi::AssistantOverridesBackgroundSound)
|
609
|
+
# * :backchanneling_enabled (Boolean)
|
610
|
+
# * :background_denoising_enabled (Boolean)
|
611
|
+
# * :model_output_in_messages_enabled (Boolean)
|
612
|
+
# * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
|
613
|
+
# * :variable_values (Hash{String => Object})
|
614
|
+
# * :name (String)
|
615
|
+
# * :first_message (String)
|
616
|
+
# * :voicemail_detection (Hash)
|
617
|
+
# * :provider (String)
|
618
|
+
# * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
|
619
|
+
# * :enabled (Boolean)
|
620
|
+
# * :machine_detection_timeout (Float)
|
621
|
+
# * :machine_detection_speech_threshold (Float)
|
622
|
+
# * :machine_detection_speech_end_threshold (Float)
|
623
|
+
# * :machine_detection_silence_timeout (Float)
|
624
|
+
# * :voicemail_message (String)
|
625
|
+
# * :end_call_message (String)
|
626
|
+
# * :end_call_phrases (Array<String>)
|
627
|
+
# * :metadata (Hash{String => Object})
|
628
|
+
# * :server_url (String)
|
629
|
+
# * :server_url_secret (String)
|
630
|
+
# * :analysis_plan (Hash)
|
631
|
+
# * :summary_plan (Hash)
|
632
|
+
# * :messages (Array<Hash{String => Object}>)
|
633
|
+
# * :enabled (Boolean)
|
634
|
+
# * :timeout_seconds (Float)
|
635
|
+
# * :structured_data_plan (Hash)
|
636
|
+
# * :messages (Array<Hash{String => Object}>)
|
637
|
+
# * :enabled (Boolean)
|
638
|
+
# * :schema (Hash)
|
639
|
+
# * :type (Vapi::JsonSchemaType)
|
640
|
+
# * :items (Hash{String => Object})
|
641
|
+
# * :properties (Hash{String => Object})
|
642
|
+
# * :description (String)
|
643
|
+
# * :required (Array<String>)
|
644
|
+
# * :timeout_seconds (Float)
|
645
|
+
# * :success_evaluation_plan (Hash)
|
646
|
+
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
647
|
+
# * :messages (Array<Hash{String => Object}>)
|
648
|
+
# * :enabled (Boolean)
|
649
|
+
# * :timeout_seconds (Float)
|
650
|
+
# * :artifact_plan (Hash)
|
651
|
+
# * :recording_enabled (Boolean)
|
652
|
+
# * :video_recording_enabled (Boolean)
|
653
|
+
# * :transcript_plan (Hash)
|
654
|
+
# * :enabled (Boolean)
|
655
|
+
# * :assistant_name (String)
|
656
|
+
# * :user_name (String)
|
657
|
+
# * :recording_path (String)
|
658
|
+
# * :message_plan (Hash)
|
659
|
+
# * :idle_messages (Array<String>)
|
660
|
+
# * :idle_message_max_spoken_count (Float)
|
661
|
+
# * :idle_timeout_seconds (Float)
|
662
|
+
# * :start_speaking_plan (Hash)
|
663
|
+
# * :wait_seconds (Float)
|
664
|
+
# * :smart_endpointing_enabled (Boolean)
|
665
|
+
# * :transcription_endpointing_plan (Hash)
|
666
|
+
# * :on_punctuation_seconds (Float)
|
667
|
+
# * :on_no_punctuation_seconds (Float)
|
668
|
+
# * :on_number_seconds (Float)
|
669
|
+
# * :stop_speaking_plan (Hash)
|
670
|
+
# * :num_words (Float)
|
671
|
+
# * :voice_seconds (Float)
|
672
|
+
# * :backoff_seconds (Float)
|
673
|
+
# * :monitor_plan (Hash)
|
674
|
+
# * :listen_enabled (Boolean)
|
675
|
+
# * :control_enabled (Boolean)
|
676
|
+
# * :credential_ids (Array<String>)
|
677
|
+
# @param request_options [Vapi::RequestOptions]
|
678
|
+
# @return [Vapi::Squad]
|
679
|
+
# @example
|
680
|
+
# api = Vapi::Client.new(
|
681
|
+
# base_url: "https://api.example.com",
|
682
|
+
# environment: Vapi::Environment::DEFAULT,
|
683
|
+
# token: "YOUR_AUTH_TOKEN"
|
684
|
+
# )
|
685
|
+
# api.squads.create(request: { members: [{ }] })
|
686
|
+
def create(request:, request_options: nil)
|
687
|
+
Async do
|
688
|
+
response = @request_client.conn.post do |req|
|
689
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
690
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
691
|
+
req.headers = {
|
692
|
+
**(req.headers || {}),
|
693
|
+
**@request_client.get_headers,
|
694
|
+
**(request_options&.additional_headers || {})
|
695
|
+
}.compact
|
696
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
697
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
698
|
+
end
|
699
|
+
req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
|
700
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/squad"
|
701
|
+
end
|
702
|
+
Vapi::Squad.from_json(json_object: response.body)
|
703
|
+
end
|
704
|
+
end
|
705
|
+
|
706
|
+
# @param id [String]
|
707
|
+
# @param request_options [Vapi::RequestOptions]
|
708
|
+
# @return [Vapi::Squad]
|
709
|
+
# @example
|
710
|
+
# api = Vapi::Client.new(
|
711
|
+
# base_url: "https://api.example.com",
|
712
|
+
# environment: Vapi::Environment::DEFAULT,
|
713
|
+
# token: "YOUR_AUTH_TOKEN"
|
714
|
+
# )
|
715
|
+
# api.squads.get(id: "id")
|
716
|
+
def get(id:, request_options: nil)
|
717
|
+
Async do
|
718
|
+
response = @request_client.conn.get do |req|
|
719
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
720
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
721
|
+
req.headers = {
|
722
|
+
**(req.headers || {}),
|
723
|
+
**@request_client.get_headers,
|
724
|
+
**(request_options&.additional_headers || {})
|
725
|
+
}.compact
|
726
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
727
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
728
|
+
end
|
729
|
+
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
730
|
+
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
|
731
|
+
end
|
732
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/squad/#{id}"
|
733
|
+
end
|
734
|
+
Vapi::Squad.from_json(json_object: response.body)
|
735
|
+
end
|
736
|
+
end
|
737
|
+
|
738
|
+
# @param id [String]
|
739
|
+
# @param request_options [Vapi::RequestOptions]
|
740
|
+
# @return [Vapi::Squad]
|
741
|
+
# @example
|
742
|
+
# api = Vapi::Client.new(
|
743
|
+
# base_url: "https://api.example.com",
|
744
|
+
# environment: Vapi::Environment::DEFAULT,
|
745
|
+
# token: "YOUR_AUTH_TOKEN"
|
746
|
+
# )
|
747
|
+
# api.squads.delete(id: "id")
|
748
|
+
def delete(id:, request_options: nil)
|
749
|
+
Async do
|
750
|
+
response = @request_client.conn.delete do |req|
|
751
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
752
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
753
|
+
req.headers = {
|
754
|
+
**(req.headers || {}),
|
755
|
+
**@request_client.get_headers,
|
756
|
+
**(request_options&.additional_headers || {})
|
757
|
+
}.compact
|
758
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
759
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
760
|
+
end
|
761
|
+
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
762
|
+
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
|
763
|
+
end
|
764
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/squad/#{id}"
|
765
|
+
end
|
766
|
+
Vapi::Squad.from_json(json_object: response.body)
|
767
|
+
end
|
768
|
+
end
|
769
|
+
|
770
|
+
# @param id [String]
|
771
|
+
# @param name [String] This is the name of the squad.
|
772
|
+
# @param members [Array<Hash>] This is the list of assistants that make up the squad.
|
773
|
+
# The call will start with the first assistant in the list.Request of type Array<Vapi::SquadMemberDto>, as a Hash
|
774
|
+
# * :assistant_id (String)
|
775
|
+
# * :assistant (Hash)
|
776
|
+
# * :transcriber (Hash)
|
777
|
+
# * :model (Hash)
|
778
|
+
# * :voice (Hash)
|
779
|
+
# * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
|
780
|
+
# * :hipaa_enabled (Boolean)
|
781
|
+
# * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
|
782
|
+
# * :server_messages (Array<Vapi::CreateAssistantDtoServerMessagesItem>)
|
783
|
+
# * :silence_timeout_seconds (Float)
|
784
|
+
# * :max_duration_seconds (Float)
|
785
|
+
# * :background_sound (Vapi::CreateAssistantDtoBackgroundSound)
|
786
|
+
# * :backchanneling_enabled (Boolean)
|
787
|
+
# * :background_denoising_enabled (Boolean)
|
788
|
+
# * :model_output_in_messages_enabled (Boolean)
|
789
|
+
# * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
|
790
|
+
# * :name (String)
|
791
|
+
# * :first_message (String)
|
792
|
+
# * :voicemail_detection (Hash)
|
793
|
+
# * :provider (String)
|
794
|
+
# * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
|
795
|
+
# * :enabled (Boolean)
|
796
|
+
# * :machine_detection_timeout (Float)
|
797
|
+
# * :machine_detection_speech_threshold (Float)
|
798
|
+
# * :machine_detection_speech_end_threshold (Float)
|
799
|
+
# * :machine_detection_silence_timeout (Float)
|
800
|
+
# * :voicemail_message (String)
|
801
|
+
# * :end_call_message (String)
|
802
|
+
# * :end_call_phrases (Array<String>)
|
803
|
+
# * :metadata (Hash{String => Object})
|
804
|
+
# * :server_url (String)
|
805
|
+
# * :server_url_secret (String)
|
806
|
+
# * :analysis_plan (Hash)
|
807
|
+
# * :summary_plan (Hash)
|
808
|
+
# * :messages (Array<Hash{String => Object}>)
|
809
|
+
# * :enabled (Boolean)
|
810
|
+
# * :timeout_seconds (Float)
|
811
|
+
# * :structured_data_plan (Hash)
|
812
|
+
# * :messages (Array<Hash{String => Object}>)
|
813
|
+
# * :enabled (Boolean)
|
814
|
+
# * :schema (Hash)
|
815
|
+
# * :type (Vapi::JsonSchemaType)
|
816
|
+
# * :items (Hash{String => Object})
|
817
|
+
# * :properties (Hash{String => Object})
|
818
|
+
# * :description (String)
|
819
|
+
# * :required (Array<String>)
|
820
|
+
# * :timeout_seconds (Float)
|
821
|
+
# * :success_evaluation_plan (Hash)
|
822
|
+
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
823
|
+
# * :messages (Array<Hash{String => Object}>)
|
824
|
+
# * :enabled (Boolean)
|
825
|
+
# * :timeout_seconds (Float)
|
826
|
+
# * :artifact_plan (Hash)
|
827
|
+
# * :recording_enabled (Boolean)
|
828
|
+
# * :video_recording_enabled (Boolean)
|
829
|
+
# * :transcript_plan (Hash)
|
830
|
+
# * :enabled (Boolean)
|
831
|
+
# * :assistant_name (String)
|
832
|
+
# * :user_name (String)
|
833
|
+
# * :recording_path (String)
|
834
|
+
# * :message_plan (Hash)
|
835
|
+
# * :idle_messages (Array<String>)
|
836
|
+
# * :idle_message_max_spoken_count (Float)
|
837
|
+
# * :idle_timeout_seconds (Float)
|
838
|
+
# * :start_speaking_plan (Hash)
|
839
|
+
# * :wait_seconds (Float)
|
840
|
+
# * :smart_endpointing_enabled (Boolean)
|
841
|
+
# * :transcription_endpointing_plan (Hash)
|
842
|
+
# * :on_punctuation_seconds (Float)
|
843
|
+
# * :on_no_punctuation_seconds (Float)
|
844
|
+
# * :on_number_seconds (Float)
|
845
|
+
# * :stop_speaking_plan (Hash)
|
846
|
+
# * :num_words (Float)
|
847
|
+
# * :voice_seconds (Float)
|
848
|
+
# * :backoff_seconds (Float)
|
849
|
+
# * :monitor_plan (Hash)
|
850
|
+
# * :listen_enabled (Boolean)
|
851
|
+
# * :control_enabled (Boolean)
|
852
|
+
# * :credential_ids (Array<String>)
|
853
|
+
# * :assistant_overrides (Hash)
|
854
|
+
# * :transcriber (Hash)
|
855
|
+
# * :model (Hash)
|
856
|
+
# * :voice (Hash)
|
857
|
+
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
858
|
+
# * :hipaa_enabled (Boolean)
|
859
|
+
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
860
|
+
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
861
|
+
# * :silence_timeout_seconds (Float)
|
862
|
+
# * :max_duration_seconds (Float)
|
863
|
+
# * :background_sound (Vapi::AssistantOverridesBackgroundSound)
|
864
|
+
# * :backchanneling_enabled (Boolean)
|
865
|
+
# * :background_denoising_enabled (Boolean)
|
866
|
+
# * :model_output_in_messages_enabled (Boolean)
|
867
|
+
# * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
|
868
|
+
# * :variable_values (Hash{String => Object})
|
869
|
+
# * :name (String)
|
870
|
+
# * :first_message (String)
|
871
|
+
# * :voicemail_detection (Hash)
|
872
|
+
# * :provider (String)
|
873
|
+
# * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
|
874
|
+
# * :enabled (Boolean)
|
875
|
+
# * :machine_detection_timeout (Float)
|
876
|
+
# * :machine_detection_speech_threshold (Float)
|
877
|
+
# * :machine_detection_speech_end_threshold (Float)
|
878
|
+
# * :machine_detection_silence_timeout (Float)
|
879
|
+
# * :voicemail_message (String)
|
880
|
+
# * :end_call_message (String)
|
881
|
+
# * :end_call_phrases (Array<String>)
|
882
|
+
# * :metadata (Hash{String => Object})
|
883
|
+
# * :server_url (String)
|
884
|
+
# * :server_url_secret (String)
|
885
|
+
# * :analysis_plan (Hash)
|
886
|
+
# * :summary_plan (Hash)
|
887
|
+
# * :messages (Array<Hash{String => Object}>)
|
888
|
+
# * :enabled (Boolean)
|
889
|
+
# * :timeout_seconds (Float)
|
890
|
+
# * :structured_data_plan (Hash)
|
891
|
+
# * :messages (Array<Hash{String => Object}>)
|
892
|
+
# * :enabled (Boolean)
|
893
|
+
# * :schema (Hash)
|
894
|
+
# * :type (Vapi::JsonSchemaType)
|
895
|
+
# * :items (Hash{String => Object})
|
896
|
+
# * :properties (Hash{String => Object})
|
897
|
+
# * :description (String)
|
898
|
+
# * :required (Array<String>)
|
899
|
+
# * :timeout_seconds (Float)
|
900
|
+
# * :success_evaluation_plan (Hash)
|
901
|
+
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
902
|
+
# * :messages (Array<Hash{String => Object}>)
|
903
|
+
# * :enabled (Boolean)
|
904
|
+
# * :timeout_seconds (Float)
|
905
|
+
# * :artifact_plan (Hash)
|
906
|
+
# * :recording_enabled (Boolean)
|
907
|
+
# * :video_recording_enabled (Boolean)
|
908
|
+
# * :transcript_plan (Hash)
|
909
|
+
# * :enabled (Boolean)
|
910
|
+
# * :assistant_name (String)
|
911
|
+
# * :user_name (String)
|
912
|
+
# * :recording_path (String)
|
913
|
+
# * :message_plan (Hash)
|
914
|
+
# * :idle_messages (Array<String>)
|
915
|
+
# * :idle_message_max_spoken_count (Float)
|
916
|
+
# * :idle_timeout_seconds (Float)
|
917
|
+
# * :start_speaking_plan (Hash)
|
918
|
+
# * :wait_seconds (Float)
|
919
|
+
# * :smart_endpointing_enabled (Boolean)
|
920
|
+
# * :transcription_endpointing_plan (Hash)
|
921
|
+
# * :on_punctuation_seconds (Float)
|
922
|
+
# * :on_no_punctuation_seconds (Float)
|
923
|
+
# * :on_number_seconds (Float)
|
924
|
+
# * :stop_speaking_plan (Hash)
|
925
|
+
# * :num_words (Float)
|
926
|
+
# * :voice_seconds (Float)
|
927
|
+
# * :backoff_seconds (Float)
|
928
|
+
# * :monitor_plan (Hash)
|
929
|
+
# * :listen_enabled (Boolean)
|
930
|
+
# * :control_enabled (Boolean)
|
931
|
+
# * :credential_ids (Array<String>)
|
932
|
+
# * :assistant_destinations (Array<Vapi::TransferDestinationAssistant>)
|
933
|
+
# @param members_overrides [Hash] This can be used to override all the assistants' settings and provide values for
|
934
|
+
# their template variables.
|
935
|
+
# Both `membersOverrides` and `members[n].assistantOverrides` can be used
|
936
|
+
# together. First, `members[n].assistantOverrides` is applied. Then,
|
937
|
+
# `membersOverrides` is applied as a global override.Request of type Vapi::AssistantOverrides, as a Hash
|
938
|
+
# * :transcriber (Hash)
|
939
|
+
# * :model (Hash)
|
940
|
+
# * :voice (Hash)
|
941
|
+
# * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
|
942
|
+
# * :hipaa_enabled (Boolean)
|
943
|
+
# * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
|
944
|
+
# * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
|
945
|
+
# * :silence_timeout_seconds (Float)
|
946
|
+
# * :max_duration_seconds (Float)
|
947
|
+
# * :background_sound (Vapi::AssistantOverridesBackgroundSound)
|
948
|
+
# * :backchanneling_enabled (Boolean)
|
949
|
+
# * :background_denoising_enabled (Boolean)
|
950
|
+
# * :model_output_in_messages_enabled (Boolean)
|
951
|
+
# * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
|
952
|
+
# * :variable_values (Hash{String => Object})
|
953
|
+
# * :name (String)
|
954
|
+
# * :first_message (String)
|
955
|
+
# * :voicemail_detection (Hash)
|
956
|
+
# * :provider (String)
|
957
|
+
# * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
|
958
|
+
# * :enabled (Boolean)
|
959
|
+
# * :machine_detection_timeout (Float)
|
960
|
+
# * :machine_detection_speech_threshold (Float)
|
961
|
+
# * :machine_detection_speech_end_threshold (Float)
|
962
|
+
# * :machine_detection_silence_timeout (Float)
|
963
|
+
# * :voicemail_message (String)
|
964
|
+
# * :end_call_message (String)
|
965
|
+
# * :end_call_phrases (Array<String>)
|
966
|
+
# * :metadata (Hash{String => Object})
|
967
|
+
# * :server_url (String)
|
968
|
+
# * :server_url_secret (String)
|
969
|
+
# * :analysis_plan (Hash)
|
970
|
+
# * :summary_plan (Hash)
|
971
|
+
# * :messages (Array<Hash{String => Object}>)
|
972
|
+
# * :enabled (Boolean)
|
973
|
+
# * :timeout_seconds (Float)
|
974
|
+
# * :structured_data_plan (Hash)
|
975
|
+
# * :messages (Array<Hash{String => Object}>)
|
976
|
+
# * :enabled (Boolean)
|
977
|
+
# * :schema (Hash)
|
978
|
+
# * :type (Vapi::JsonSchemaType)
|
979
|
+
# * :items (Hash{String => Object})
|
980
|
+
# * :properties (Hash{String => Object})
|
981
|
+
# * :description (String)
|
982
|
+
# * :required (Array<String>)
|
983
|
+
# * :timeout_seconds (Float)
|
984
|
+
# * :success_evaluation_plan (Hash)
|
985
|
+
# * :rubric (Vapi::SuccessEvaluationPlanRubric)
|
986
|
+
# * :messages (Array<Hash{String => Object}>)
|
987
|
+
# * :enabled (Boolean)
|
988
|
+
# * :timeout_seconds (Float)
|
989
|
+
# * :artifact_plan (Hash)
|
990
|
+
# * :recording_enabled (Boolean)
|
991
|
+
# * :video_recording_enabled (Boolean)
|
992
|
+
# * :transcript_plan (Hash)
|
993
|
+
# * :enabled (Boolean)
|
994
|
+
# * :assistant_name (String)
|
995
|
+
# * :user_name (String)
|
996
|
+
# * :recording_path (String)
|
997
|
+
# * :message_plan (Hash)
|
998
|
+
# * :idle_messages (Array<String>)
|
999
|
+
# * :idle_message_max_spoken_count (Float)
|
1000
|
+
# * :idle_timeout_seconds (Float)
|
1001
|
+
# * :start_speaking_plan (Hash)
|
1002
|
+
# * :wait_seconds (Float)
|
1003
|
+
# * :smart_endpointing_enabled (Boolean)
|
1004
|
+
# * :transcription_endpointing_plan (Hash)
|
1005
|
+
# * :on_punctuation_seconds (Float)
|
1006
|
+
# * :on_no_punctuation_seconds (Float)
|
1007
|
+
# * :on_number_seconds (Float)
|
1008
|
+
# * :stop_speaking_plan (Hash)
|
1009
|
+
# * :num_words (Float)
|
1010
|
+
# * :voice_seconds (Float)
|
1011
|
+
# * :backoff_seconds (Float)
|
1012
|
+
# * :monitor_plan (Hash)
|
1013
|
+
# * :listen_enabled (Boolean)
|
1014
|
+
# * :control_enabled (Boolean)
|
1015
|
+
# * :credential_ids (Array<String>)
|
1016
|
+
# @param request_options [Vapi::RequestOptions]
|
1017
|
+
# @return [Vapi::Squad]
|
1018
|
+
# @example
|
1019
|
+
# api = Vapi::Client.new(
|
1020
|
+
# base_url: "https://api.example.com",
|
1021
|
+
# environment: Vapi::Environment::DEFAULT,
|
1022
|
+
# token: "YOUR_AUTH_TOKEN"
|
1023
|
+
# )
|
1024
|
+
# api.squads.update(id: "id", members: [{ }])
|
1025
|
+
def update(id:, members:, name: nil, members_overrides: nil, request_options: nil)
|
1026
|
+
Async do
|
1027
|
+
response = @request_client.conn.patch do |req|
|
1028
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
1029
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
1030
|
+
req.headers = {
|
1031
|
+
**(req.headers || {}),
|
1032
|
+
**@request_client.get_headers,
|
1033
|
+
**(request_options&.additional_headers || {})
|
1034
|
+
}.compact
|
1035
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
1036
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
1037
|
+
end
|
1038
|
+
req.body = {
|
1039
|
+
**(request_options&.additional_body_parameters || {}),
|
1040
|
+
name: name,
|
1041
|
+
members: members,
|
1042
|
+
membersOverrides: members_overrides
|
1043
|
+
}.compact
|
1044
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/squad/#{id}"
|
1045
|
+
end
|
1046
|
+
Vapi::Squad.from_json(json_object: response.body)
|
1047
|
+
end
|
1048
|
+
end
|
1049
|
+
end
|
1050
|
+
end
|