vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/assistants/client.rb

@@ -9,12 +9,16 @@ require_relative "types/update_assistant_dto_transcriber"
 require_relative "types/update_assistant_dto_model"
 require_relative "types/update_assistant_dto_voice"
 require_relative "types/update_assistant_dto_first_message_mode"
+require_relative "types/update_assistant_dto_voicemail_detection"
 require_relative "types/update_assistant_dto_client_messages_item"
 require_relative "types/update_assistant_dto_server_messages_item"
 require_relative "types/update_assistant_dto_background_sound"
 require_relative "../types/transport_configuration_twilio"
+require_relative "../types/langfuse_observability_plan"
 require_relative "types/update_assistant_dto_credentials_item"
-require_relative "../types/twilio_voicemail_detection"
+require_relative "types/update_assistant_dto_hooks_item"
+require_relative "../types/compliance_plan"
+require_relative "../types/background_speech_denoising_plan"
 require_relative "../types/analysis_plan"
 require_relative "../types/artifact_plan"
 require_relative "../types/message_plan"
@@ -22,6 +26,7 @@ require_relative "../types/start_speaking_plan"
 require_relative "../types/stop_speaking_plan"
 require_relative "../types/monitor_plan"
 require_relative "../types/server"
+require_relative "../types/keypad_input_plan"
 require "async"
 
 module Vapi
@@ -89,31 +94,43 @@ module Vapi
     #   * :model (Hash)
     #   * :voice (Hash)
     #   * :first_message (String)
+    #   * :first_message_interruptions_enabled (Boolean)
     #   * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
-    #   * :hipaa_enabled (Boolean)
+    #   * :voicemail_detection (Hash)
     #   * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
     #   * :server_messages (Array<Vapi::CreateAssistantDtoServerMessagesItem>)
     #   * :silence_timeout_seconds (Float)
     #   * :max_duration_seconds (Float)
-    #   * :background_sound (Vapi::CreateAssistantDtoBackgroundSound)
+    #   * :background_sound (Hash)
     #   * :background_denoising_enabled (Boolean)
     #   * :model_output_in_messages_enabled (Boolean)
     #   * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
+    #   * :observability_plan (Hash)
+    #     * :provider (String)
+    #     * :tags (Array<String>)
+    #     * :metadata (Hash{String => Object})
     #   * :credentials (Array<Vapi::CreateAssistantDtoCredentialsItem>)
+    #   * :hooks (Array<Vapi::CreateAssistantDtoHooksItem>)
     #   * :name (String)
-    #   * :voicemail_detection (Hash)
-    #     * :provider (String)
-    #     * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
-    #     * :enabled (Boolean)
-    #     * :machine_detection_timeout (Float)
-    #     * :machine_detection_speech_threshold (Float)
-    #     * :machine_detection_speech_end_threshold (Float)
-    #     * :machine_detection_silence_timeout (Float)
     #   * :voicemail_message (String)
     #   * :end_call_message (String)
     #   * :end_call_phrases (Array<String>)
+    #   * :compliance_plan (Hash)
+    #     * :hipaa_enabled (Boolean)
+    #     * :pci_enabled (Boolean)
     #   * :metadata (Hash{String => Object})
+    #   * :background_speech_denoising_plan (Hash)
+    #     * :smart_denoising_plan (Hash)
+    #       * :enabled (Boolean)
+    #     * :fourier_denoising_plan (Hash)
+    #       * :enabled (Boolean)
+    #       * :media_detection_enabled (Boolean)
+    #       * :static_threshold (Float)
+    #       * :baseline_offset_db (Float)
+    #       * :window_size_ms (Float)
+    #       * :baseline_percentile (Float)
     #   * :analysis_plan (Hash)
+    #     * :min_messages_threshold (Float)
     #     * :summary_plan (Hash)
     #       * :messages (Array<Hash{String => Object}>)
     #       * :enabled (Boolean)
@@ -126,9 +143,13 @@ module Vapi
     #         * :items (Hash{String => Object})
     #         * :properties (Hash{String => Object})
     #         * :description (String)
+    #         * :pattern (String)
+    #         * :format (Vapi::JsonSchemaFormat)
     #         * :required (Array<String>)
     #         * :enum (Array<String>)
+    #         * :title (String)
     #       * :timeout_seconds (Float)
+    #     * :structured_data_multi_plan (Array<Vapi::StructuredDataMultiPlan>)
     #     * :success_evaluation_plan (Hash)
     #       * :rubric (Vapi::SuccessEvaluationPlanRubric)
     #       * :messages (Array<Hash{String => Object}>)
@@ -136,7 +157,10 @@ module Vapi
     #       * :timeout_seconds (Float)
     #   * :artifact_plan (Hash)
     #     * :recording_enabled (Boolean)
+    #     * :recording_format (Vapi::ArtifactPlanRecordingFormat)
     #     * :video_recording_enabled (Boolean)
+    #     * :pcap_enabled (Boolean)
+    #     * :pcap_s_3_path_prefix (String)
     #     * :transcript_plan (Hash)
     #       * :enabled (Boolean)
     #       * :assistant_name (String)
@@ -145,10 +169,13 @@ module Vapi
     #   * :message_plan (Hash)
     #     * :idle_messages (Array<String>)
     #     * :idle_message_max_spoken_count (Float)
+    #     * :idle_message_reset_count_on_user_speech_enabled (Boolean)
     #     * :idle_timeout_seconds (Float)
+    #     * :silence_timeout_message (String)
     #   * :start_speaking_plan (Hash)
     #     * :wait_seconds (Float)
-    #     * :smart_endpointing_enabled (Boolean)
+    #     * :smart_endpointing_enabled (Hash)
+    #     * :smart_endpointing_plan (Hash)
     #     * :custom_endpointing_rules (Array<Vapi::StartSpeakingPlanCustomEndpointingRulesItem>)
     #     * :transcription_endpointing_plan (Hash)
     #       * :on_punctuation_seconds (Float)
@@ -158,15 +185,26 @@ module Vapi
     #     * :num_words (Float)
     #     * :voice_seconds (Float)
     #     * :backoff_seconds (Float)
+    #     * :acknowledgement_phrases (Array<String>)
+    #     * :interruption_phrases (Array<String>)
     #   * :monitor_plan (Hash)
     #     * :listen_enabled (Boolean)
+    #     * :listen_authentication_enabled (Boolean)
     #     * :control_enabled (Boolean)
+    #     * :control_authentication_enabled (Boolean)
     #   * :credential_ids (Array<String>)
     #   * :server (Hash)
     #     * :timeout_seconds (Float)
     #     * :url (String)
-    #     * :secret (String)
     #     * :headers (Hash{String => Object})
+    #     * :backoff_plan (Hash)
+    #       * :type (Hash{String => Object})
+    #       * :max_retries (Float)
+    #       * :base_delay_seconds (Float)
+    #   * :keypad_input_plan (Hash)
+    #     * :enabled (Boolean)
+    #     * :timeout_seconds (Float)
+    #     * :delimiters (Vapi::KeypadInputPlanDelimiters)
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Assistant]
     def create(request:, request_options: nil)
@@ -241,6 +279,7 @@ module Vapi
     #  a containerized audio file (mp3, wav, etc.).
     #  If unspecified, assistant will wait for user to speak and use the model to
     #  respond once they speak.
+    # @param first_message_interruptions_enabled [Boolean]
     # @param first_message_mode [Vapi::Assistants::UpdateAssistantDtoFirstMessageMode] This is the mode for the first message. Default is 'assistant-speaks-first'.
     #  Use:
     #  - 'assistant-speaks-first' to have the assistant speak first.
@@ -251,11 +290,15 @@ module Vapi
     #  state. (`assistant.model.messages` at call start, `call.messages` at squad
     #  transfer points).
     #  @default 'assistant-speaks-first'
-    # @param hipaa_enabled [Boolean] When this is enabled, no logs, recordings, or transcriptions will be stored. At
-    #  the end of the call, you will still receive an end-of-call-report message to
-    #  store on your server. Defaults to false.
+    # @param voicemail_detection [Vapi::Assistants::UpdateAssistantDtoVoicemailDetection] These are the settings to configure or disable voicemail detection.
+    #  Alternatively, voicemail detection can be configured using the
+    #  model.tools=[VoicemailTool].
+    #  This uses Twilio's built-in detection while the VoicemailTool relies on the
+    #  model to detect if a voicemail was reached.
+    #  You can use neither of them, one of them, or both of them. By default, Twilio
+    #  built-in detection is enabled while VoicemailTool is not.
     # @param client_messages [Array<Vapi::Assistants::UpdateAssistantDtoClientMessagesItem>] These are the messages that will be sent to your Client SDKs. Default is
-    #  tatus-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input.
+    #  update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started.
     #  You can check the shape of the messages in ClientMessage schema.
     # @param server_messages [Array<Vapi::Assistants::UpdateAssistantDtoServerMessagesItem>] These are the messages that will be sent to your Server URL. Default is
     #  h-update,status-update,tool-calls,transfer-destination-request,user-interrupted.
@@ -265,8 +308,9 @@ module Vapi
     # @param max_duration_seconds [Float] This is the maximum number of seconds that the call will last. When the call
     #  reaches this duration, it will be ended.
     #  @default 600 (10 minutes)
-    # @param background_sound [Vapi::Assistants::UpdateAssistantDtoBackgroundSound] This is the background sound in the call. Default for phone calls is 'office'
+    # @param background_sound [Vapi::Assistants::UpdateAssistantDtoBackgroundSoundZero, String] This is the background sound in the call. Default for phone calls is 'office'
     #  and default for web calls is 'off'.
+    #  You can also provide a custom sound by providing a URL to an audio file.
     # @param background_denoising_enabled [Boolean] This enables filtering of noise and background speech while the user is talking.
     #  Default `false` while in beta.
     #  @default false
@@ -282,26 +326,18 @@ module Vapi
     #   * :timeout (Float)
     #   * :record (Boolean)
     #   * :recording_channels (Vapi::TransportConfigurationTwilioRecordingChannels)
+    # @param observability_plan [Hash] This is the plan for observability of assistant's calls.
+    #  Currently, only Langfuse is supported.Request of type Vapi::LangfuseObservabilityPlan, as a Hash
+    #   * :provider (String)
+    #   * :tags (Array<String>)
+    #   * :metadata (Hash{String => Object})
     # @param credentials [Array<Hash>] These are dynamic credentials that will be used for the assistant calls. By
     #  default, all the credentials are available for use in the call but you can
     #  supplement an additional credentials using this. Dynamic credentials override
     #  existing credentials.Request of type Array<Vapi::Assistants::UpdateAssistantDtoCredentialsItem>, as a Hash
+    # @param hooks [Array<Hash>] This is a set of actions that will be performed on certain events.Request of type Array<Vapi::Assistants::UpdateAssistantDtoHooksItem>, as a Hash
     # @param name [String] This is the name of the assistant.
     #  This is required when you want to transfer between assistants in a call.
-    # @param voicemail_detection [Hash] These are the settings to configure or disable voicemail detection.
-    #  Alternatively, voicemail detection can be configured using the
-    #  model.tools=[VoicemailTool].
-    #  This uses Twilio's built-in detection while the VoicemailTool relies on the
-    #  model to detect if a voicemail was reached.
-    #  You can use neither of them, one of them, or both of them. By default, Twilio
-    #  built-in detection is enabled while VoicemailTool is not.Request of type Vapi::TwilioVoicemailDetection, as a Hash
-    #   * :provider (String)
-    #   * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
-    #   * :enabled (Boolean)
-    #   * :machine_detection_timeout (Float)
-    #   * :machine_detection_speech_threshold (Float)
-    #   * :machine_detection_speech_end_threshold (Float)
-    #   * :machine_detection_silence_timeout (Float)
     # @param voicemail_message [String] This is the message that the assistant will say if the call is forwarded to
     #  voicemail.
     #  If unspecified, it will hang up.
@@ -309,8 +345,29 @@ module Vapi
     #  If unspecified, it will hang up without saying anything.
     # @param end_call_phrases [Array<String>] This list contains phrases that, if spoken by the assistant, will trigger the
     #  call to be hung up. Case insensitive.
+    # @param compliance_plan [Hash] Request of type Vapi::CompliancePlan, as a Hash
+    #   * :hipaa_enabled (Boolean)
+    #   * :pci_enabled (Boolean)
     # @param metadata [Hash{String => Object}] This is for metadata you want to store on the assistant.
+    # @param background_speech_denoising_plan [Hash] This enables filtering of noise and background speech while the user is talking.
+    #  Features:
+    #  - Smart denoising using Krisp
+    #  - Fourier denoising
+    #  Smart denoising can be combined with or used independently of Fourier denoising.
+    #  Order of precedence:
+    #  - Smart denoising
+    #  - Fourier denoisingRequest of type Vapi::BackgroundSpeechDenoisingPlan, as a Hash
+    #   * :smart_denoising_plan (Hash)
+    #     * :enabled (Boolean)
+    #   * :fourier_denoising_plan (Hash)
+    #     * :enabled (Boolean)
+    #     * :media_detection_enabled (Boolean)
+    #     * :static_threshold (Float)
+    #     * :baseline_offset_db (Float)
+    #     * :window_size_ms (Float)
+    #     * :baseline_percentile (Float)
     # @param analysis_plan [Hash] This is the plan for analysis of assistant's calls. Stored in `call.analysis`.Request of type Vapi::AnalysisPlan, as a Hash
+    #   * :min_messages_threshold (Float)
     #   * :summary_plan (Hash)
     #     * :messages (Array<Hash{String => Object}>)
     #     * :enabled (Boolean)
@@ -323,20 +380,25 @@ module Vapi
     #       * :items (Hash{String => Object})
     #       * :properties (Hash{String => Object})
     #       * :description (String)
+    #       * :pattern (String)
+    #       * :format (Vapi::JsonSchemaFormat)
     #       * :required (Array<String>)
     #       * :enum (Array<String>)
+    #       * :title (String)
     #     * :timeout_seconds (Float)
+    #   * :structured_data_multi_plan (Array<Vapi::StructuredDataMultiPlan>)
     #   * :success_evaluation_plan (Hash)
     #     * :rubric (Vapi::SuccessEvaluationPlanRubric)
     #     * :messages (Array<Hash{String => Object}>)
     #     * :enabled (Boolean)
     #     * :timeout_seconds (Float)
     # @param artifact_plan [Hash] This is the plan for artifacts generated during assistant's calls. Stored in
-    #  `call.artifact`.
-    #  Note: `recordingEnabled` is currently at the root level. It will be moved to
-    #  `artifactPlan` in the future, but will remain backwards compatible.Request of type Vapi::ArtifactPlan, as a Hash
+    #  `call.artifact`.Request of type Vapi::ArtifactPlan, as a Hash
     #   * :recording_enabled (Boolean)
+    #   * :recording_format (Vapi::ArtifactPlanRecordingFormat)
     #   * :video_recording_enabled (Boolean)
+    #   * :pcap_enabled (Boolean)
+    #   * :pcap_s_3_path_prefix (String)
     #   * :transcript_plan (Hash)
     #     * :enabled (Boolean)
     #     * :assistant_name (String)
@@ -349,7 +411,9 @@ module Vapi
     #  remain backwards compatible.Request of type Vapi::MessagePlan, as a Hash
     #   * :idle_messages (Array<String>)
     #   * :idle_message_max_spoken_count (Float)
+    #   * :idle_message_reset_count_on_user_speech_enabled (Boolean)
     #   * :idle_timeout_seconds (Float)
+    #   * :silence_timeout_message (String)
     # @param start_speaking_plan [Hash] This is the plan for when the assistant should start talking.
     #  You should configure this if you're running into these issues:
     #  - The assistant is too slow to start talking after the customer is done
@@ -358,7 +422,8 @@ module Vapi
     #  speaking.
     #  - The assistant is so fast that it's actually interrupting the customer.Request of type Vapi::StartSpeakingPlan, as a Hash
     #   * :wait_seconds (Float)
-    #   * :smart_endpointing_enabled (Boolean)
+    #   * :smart_endpointing_enabled (Hash)
+    #   * :smart_endpointing_plan (Hash)
     #   * :custom_endpointing_rules (Array<Vapi::StartSpeakingPlanCustomEndpointingRulesItem>)
     #   * :transcription_endpointing_plan (Hash)
     #     * :on_punctuation_seconds (Float)
@@ -376,17 +441,18 @@ module Vapi
     #   * :num_words (Float)
     #   * :voice_seconds (Float)
     #   * :backoff_seconds (Float)
+    #   * :acknowledgement_phrases (Array<String>)
+    #   * :interruption_phrases (Array<String>)
     # @param monitor_plan [Hash] This is the plan for real-time monitoring of the assistant's calls.
     #  Usage:
     #  - To enable live listening of the assistant's calls, set
     #  `monitorPlan.listenEnabled` to `true`.
     #  - To enable live control of the assistant's calls, set
-    #  `monitorPlan.controlEnabled` to `true`.
-    #  Note, `serverMessages`, `clientMessages`, `serverUrl` and `serverUrlSecret` are
-    #  currently at the root level but will be moved to `monitorPlan` in the future.
-    #  Will remain backwards compatibleRequest of type Vapi::MonitorPlan, as a Hash
+    #  `monitorPlan.controlEnabled` to `true`.Request of type Vapi::MonitorPlan, as a Hash
     #   * :listen_enabled (Boolean)
+    #   * :listen_authentication_enabled (Boolean)
     #   * :control_enabled (Boolean)
+    #   * :control_authentication_enabled (Boolean)
     # @param credential_ids [Array<String>] These are the credentials that will be used for the assistant calls. By default,
     #  all the credentials are available for use in the call but you can provide a
     #  subset using this.
@@ -398,12 +464,19 @@ module Vapi
     #  3. org.serverUrlRequest of type Vapi::Server, as a Hash
     #   * :timeout_seconds (Float)
     #   * :url (String)
-    #   * :secret (String)
     #   * :headers (Hash{String => Object})
+    #   * :backoff_plan (Hash)
+    #     * :type (Hash{String => Object})
+    #     * :max_retries (Float)
+    #     * :base_delay_seconds (Float)
+    # @param keypad_input_plan [Hash] Request of type Vapi::KeypadInputPlan, as a Hash
+    #   * :enabled (Boolean)
+    #   * :timeout_seconds (Float)
+    #   * :delimiters (Vapi::KeypadInputPlanDelimiters)
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Assistant]
-    def update(id:, transcriber: nil, model: nil, voice: nil, first_message: nil, first_message_mode: nil,
-               hipaa_enabled: nil, client_messages: nil, server_messages: nil, silence_timeout_seconds: nil, max_duration_seconds: nil, background_sound: nil, background_denoising_enabled: nil, model_output_in_messages_enabled: nil, transport_configurations: nil, credentials: nil, name: nil, voicemail_detection: nil, voicemail_message: nil, end_call_message: nil, end_call_phrases: nil, metadata: nil, analysis_plan: nil, artifact_plan: nil, message_plan: nil, start_speaking_plan: nil, stop_speaking_plan: nil, monitor_plan: nil, credential_ids: nil, server: nil, request_options: nil)
+    def update(id:, transcriber: nil, model: nil, voice: nil, first_message: nil,
+               first_message_interruptions_enabled: nil, first_message_mode: nil, voicemail_detection: nil, client_messages: nil, server_messages: nil, silence_timeout_seconds: nil, max_duration_seconds: nil, background_sound: nil, background_denoising_enabled: nil, model_output_in_messages_enabled: nil, transport_configurations: nil, observability_plan: nil, credentials: nil, hooks: nil, name: nil, voicemail_message: nil, end_call_message: nil, end_call_phrases: nil, compliance_plan: nil, metadata: nil, background_speech_denoising_plan: nil, analysis_plan: nil, artifact_plan: nil, message_plan: nil, start_speaking_plan: nil, stop_speaking_plan: nil, monitor_plan: nil, credential_ids: nil, server: nil, keypad_input_plan: nil, request_options: nil)
       response = @request_client.conn.patch do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -421,8 +494,9 @@ module Vapi
           model: model,
           voice: voice,
           firstMessage: first_message,
+          firstMessageInterruptionsEnabled: first_message_interruptions_enabled,
           firstMessageMode: first_message_mode,
-          hipaaEnabled: hipaa_enabled,
+          voicemailDetection: voicemail_detection,
           clientMessages: client_messages,
           serverMessages: server_messages,
           silenceTimeoutSeconds: silence_timeout_seconds,
@@ -431,13 +505,16 @@ module Vapi
           backgroundDenoisingEnabled: background_denoising_enabled,
           modelOutputInMessagesEnabled: model_output_in_messages_enabled,
           transportConfigurations: transport_configurations,
+          observabilityPlan: observability_plan,
           credentials: credentials,
+          hooks: hooks,
           name: name,
-          voicemailDetection: voicemail_detection,
           voicemailMessage: voicemail_message,
           endCallMessage: end_call_message,
           endCallPhrases: end_call_phrases,
+          compliancePlan: compliance_plan,
           metadata: metadata,
+          backgroundSpeechDenoisingPlan: background_speech_denoising_plan,
           analysisPlan: analysis_plan,
           artifactPlan: artifact_plan,
           messagePlan: message_plan,
@@ -445,7 +522,8 @@ module Vapi
           stopSpeakingPlan: stop_speaking_plan,
           monitorPlan: monitor_plan,
           credentialIds: credential_ids,
-          server: server
+          server: server,
+          keypadInputPlan: keypad_input_plan
         }.compact
         req.url "#{@request_client.get_url(request_options: request_options)}/assistant/#{id}"
       end
@@ -519,31 +597,43 @@ module Vapi
     #   * :model (Hash)
     #   * :voice (Hash)
     #   * :first_message (String)
+    #   * :first_message_interruptions_enabled (Boolean)
     #   * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
-    #   * :hipaa_enabled (Boolean)
+    #   * :voicemail_detection (Hash)
     #   * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
     #   * :server_messages (Array<Vapi::CreateAssistantDtoServerMessagesItem>)
     #   * :silence_timeout_seconds (Float)
     #   * :max_duration_seconds (Float)
-    #   * :background_sound (Vapi::CreateAssistantDtoBackgroundSound)
+    #   * :background_sound (Hash)
     #   * :background_denoising_enabled (Boolean)
     #   * :model_output_in_messages_enabled (Boolean)
     #   * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
+    #   * :observability_plan (Hash)
+    #     * :provider (String)
+    #     * :tags (Array<String>)
+    #     * :metadata (Hash{String => Object})
     #   * :credentials (Array<Vapi::CreateAssistantDtoCredentialsItem>)
+    #   * :hooks (Array<Vapi::CreateAssistantDtoHooksItem>)
     #   * :name (String)
-    #   * :voicemail_detection (Hash)
-    #     * :provider (String)
-    #     * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
-    #     * :enabled (Boolean)
-    #     * :machine_detection_timeout (Float)
-    #     * :machine_detection_speech_threshold (Float)
-    #     * :machine_detection_speech_end_threshold (Float)
-    #     * :machine_detection_silence_timeout (Float)
     #   * :voicemail_message (String)
     #   * :end_call_message (String)
     #   * :end_call_phrases (Array<String>)
+    #   * :compliance_plan (Hash)
+    #     * :hipaa_enabled (Boolean)
+    #     * :pci_enabled (Boolean)
     #   * :metadata (Hash{String => Object})
+    #   * :background_speech_denoising_plan (Hash)
+    #     * :smart_denoising_plan (Hash)
+    #       * :enabled (Boolean)
+    #     * :fourier_denoising_plan (Hash)
+    #       * :enabled (Boolean)
+    #       * :media_detection_enabled (Boolean)
+    #       * :static_threshold (Float)
+    #       * :baseline_offset_db (Float)
+    #       * :window_size_ms (Float)
+    #       * :baseline_percentile (Float)
     #   * :analysis_plan (Hash)
+    #     * :min_messages_threshold (Float)
     #     * :summary_plan (Hash)
     #       * :messages (Array<Hash{String => Object}>)
     #       * :enabled (Boolean)
@@ -556,9 +646,13 @@ module Vapi
     #         * :items (Hash{String => Object})
     #         * :properties (Hash{String => Object})
     #         * :description (String)
+    #         * :pattern (String)
+    #         * :format (Vapi::JsonSchemaFormat)
     #         * :required (Array<String>)
     #         * :enum (Array<String>)
+    #         * :title (String)
     #       * :timeout_seconds (Float)
+    #     * :structured_data_multi_plan (Array<Vapi::StructuredDataMultiPlan>)
     #     * :success_evaluation_plan (Hash)
     #       * :rubric (Vapi::SuccessEvaluationPlanRubric)
     #       * :messages (Array<Hash{String => Object}>)
@@ -566,7 +660,10 @@ module Vapi
     #       * :timeout_seconds (Float)
     #   * :artifact_plan (Hash)
     #     * :recording_enabled (Boolean)
+    #     * :recording_format (Vapi::ArtifactPlanRecordingFormat)
     #     * :video_recording_enabled (Boolean)
+    #     * :pcap_enabled (Boolean)
+    #     * :pcap_s_3_path_prefix (String)
     #     * :transcript_plan (Hash)
     #       * :enabled (Boolean)
     #       * :assistant_name (String)
@@ -575,10 +672,13 @@ module Vapi
     #   * :message_plan (Hash)
     #     * :idle_messages (Array<String>)
     #     * :idle_message_max_spoken_count (Float)
+    #     * :idle_message_reset_count_on_user_speech_enabled (Boolean)
     #     * :idle_timeout_seconds (Float)
+    #     * :silence_timeout_message (String)
     #   * :start_speaking_plan (Hash)
     #     * :wait_seconds (Float)
-    #     * :smart_endpointing_enabled (Boolean)
+    #     * :smart_endpointing_enabled (Hash)
+    #     * :smart_endpointing_plan (Hash)
     #     * :custom_endpointing_rules (Array<Vapi::StartSpeakingPlanCustomEndpointingRulesItem>)
     #     * :transcription_endpointing_plan (Hash)
     #       * :on_punctuation_seconds (Float)
@@ -588,15 +688,26 @@ module Vapi
     #     * :num_words (Float)
     #     * :voice_seconds (Float)
     #     * :backoff_seconds (Float)
+    #     * :acknowledgement_phrases (Array<String>)
+    #     * :interruption_phrases (Array<String>)
     #   * :monitor_plan (Hash)
     #     * :listen_enabled (Boolean)
+    #     * :listen_authentication_enabled (Boolean)
     #     * :control_enabled (Boolean)
+    #     * :control_authentication_enabled (Boolean)
     #   * :credential_ids (Array<String>)
     #   * :server (Hash)
     #     * :timeout_seconds (Float)
     #     * :url (String)
-    #     * :secret (String)
     #     * :headers (Hash{String => Object})
+    #     * :backoff_plan (Hash)
+    #       * :type (Hash{String => Object})
+    #       * :max_retries (Float)
+    #       * :base_delay_seconds (Float)
+    #   * :keypad_input_plan (Hash)
+    #     * :enabled (Boolean)
+    #     * :timeout_seconds (Float)
+    #     * :delimiters (Vapi::KeypadInputPlanDelimiters)
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Assistant]
     def create(request:, request_options: nil)
@@ -677,6 +788,7 @@ module Vapi
     #  a containerized audio file (mp3, wav, etc.).
     #  If unspecified, assistant will wait for user to speak and use the model to
     #  respond once they speak.
+    # @param first_message_interruptions_enabled [Boolean]
     # @param first_message_mode [Vapi::Assistants::UpdateAssistantDtoFirstMessageMode] This is the mode for the first message. Default is 'assistant-speaks-first'.
     #  Use:
     #  - 'assistant-speaks-first' to have the assistant speak first.
@@ -687,11 +799,15 @@ module Vapi
     #  state. (`assistant.model.messages` at call start, `call.messages` at squad
     #  transfer points).
     #  @default 'assistant-speaks-first'
-    # @param hipaa_enabled [Boolean] When this is enabled, no logs, recordings, or transcriptions will be stored. At
-    #  the end of the call, you will still receive an end-of-call-report message to
-    #  store on your server. Defaults to false.
+    # @param voicemail_detection [Vapi::Assistants::UpdateAssistantDtoVoicemailDetection] These are the settings to configure or disable voicemail detection.
+    #  Alternatively, voicemail detection can be configured using the
+    #  model.tools=[VoicemailTool].
+    #  This uses Twilio's built-in detection while the VoicemailTool relies on the
+    #  model to detect if a voicemail was reached.
+    #  You can use neither of them, one of them, or both of them. By default, Twilio
+    #  built-in detection is enabled while VoicemailTool is not.
     # @param client_messages [Array<Vapi::Assistants::UpdateAssistantDtoClientMessagesItem>] These are the messages that will be sent to your Client SDKs. Default is
-    #  tatus-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input.
+    #  update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started.
     #  You can check the shape of the messages in ClientMessage schema.
     # @param server_messages [Array<Vapi::Assistants::UpdateAssistantDtoServerMessagesItem>] These are the messages that will be sent to your Server URL. Default is
     #  h-update,status-update,tool-calls,transfer-destination-request,user-interrupted.
@@ -701,8 +817,9 @@ module Vapi
     # @param max_duration_seconds [Float] This is the maximum number of seconds that the call will last. When the call
     #  reaches this duration, it will be ended.
     #  @default 600 (10 minutes)
-    # @param background_sound [Vapi::Assistants::UpdateAssistantDtoBackgroundSound] This is the background sound in the call. Default for phone calls is 'office'
+    # @param background_sound [Vapi::Assistants::UpdateAssistantDtoBackgroundSoundZero, String] This is the background sound in the call. Default for phone calls is 'office'
     #  and default for web calls is 'off'.
+    #  You can also provide a custom sound by providing a URL to an audio file.
     # @param background_denoising_enabled [Boolean] This enables filtering of noise and background speech while the user is talking.
     #  Default `false` while in beta.
     #  @default false
@@ -718,26 +835,18 @@ module Vapi
     #   * :timeout (Float)
     #   * :record (Boolean)
     #   * :recording_channels (Vapi::TransportConfigurationTwilioRecordingChannels)
+    # @param observability_plan [Hash] This is the plan for observability of assistant's calls.
+    #  Currently, only Langfuse is supported.Request of type Vapi::LangfuseObservabilityPlan, as a Hash
+    #   * :provider (String)
+    #   * :tags (Array<String>)
+    #   * :metadata (Hash{String => Object})
     # @param credentials [Array<Hash>] These are dynamic credentials that will be used for the assistant calls. By
     #  default, all the credentials are available for use in the call but you can
     #  supplement an additional credentials using this. Dynamic credentials override
     #  existing credentials.Request of type Array<Vapi::Assistants::UpdateAssistantDtoCredentialsItem>, as a Hash
+    # @param hooks [Array<Hash>] This is a set of actions that will be performed on certain events.Request of type Array<Vapi::Assistants::UpdateAssistantDtoHooksItem>, as a Hash
     # @param name [String] This is the name of the assistant.
     #  This is required when you want to transfer between assistants in a call.
-    # @param voicemail_detection [Hash] These are the settings to configure or disable voicemail detection.
-    #  Alternatively, voicemail detection can be configured using the
-    #  model.tools=[VoicemailTool].
-    #  This uses Twilio's built-in detection while the VoicemailTool relies on the
-    #  model to detect if a voicemail was reached.
-    #  You can use neither of them, one of them, or both of them. By default, Twilio
-    #  built-in detection is enabled while VoicemailTool is not.Request of type Vapi::TwilioVoicemailDetection, as a Hash
-    #   * :provider (String)
-    #   * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
-    #   * :enabled (Boolean)
-    #   * :machine_detection_timeout (Float)
-    #   * :machine_detection_speech_threshold (Float)
-    #   * :machine_detection_speech_end_threshold (Float)
-    #   * :machine_detection_silence_timeout (Float)
     # @param voicemail_message [String] This is the message that the assistant will say if the call is forwarded to
     #  voicemail.
     #  If unspecified, it will hang up.
@@ -745,8 +854,29 @@ module Vapi
     #  If unspecified, it will hang up without saying anything.
     # @param end_call_phrases [Array<String>] This list contains phrases that, if spoken by the assistant, will trigger the
     #  call to be hung up. Case insensitive.
+    # @param compliance_plan [Hash] Request of type Vapi::CompliancePlan, as a Hash
+    #   * :hipaa_enabled (Boolean)
+    #   * :pci_enabled (Boolean)
     # @param metadata [Hash{String => Object}] This is for metadata you want to store on the assistant.
+    # @param background_speech_denoising_plan [Hash] This enables filtering of noise and background speech while the user is talking.
+    #  Features:
+    #  - Smart denoising using Krisp
+    #  - Fourier denoising
+    #  Smart denoising can be combined with or used independently of Fourier denoising.
+    #  Order of precedence:
+    #  - Smart denoising
+    #  - Fourier denoisingRequest of type Vapi::BackgroundSpeechDenoisingPlan, as a Hash
+    #   * :smart_denoising_plan (Hash)
+    #     * :enabled (Boolean)
+    #   * :fourier_denoising_plan (Hash)
+    #     * :enabled (Boolean)
+    #     * :media_detection_enabled (Boolean)
+    #     * :static_threshold (Float)
+    #     * :baseline_offset_db (Float)
+    #     * :window_size_ms (Float)
+    #     * :baseline_percentile (Float)
     # @param analysis_plan [Hash] This is the plan for analysis of assistant's calls. Stored in `call.analysis`.Request of type Vapi::AnalysisPlan, as a Hash
+    #   * :min_messages_threshold (Float)
     #   * :summary_plan (Hash)
     #     * :messages (Array<Hash{String => Object}>)
     #     * :enabled (Boolean)
@@ -759,20 +889,25 @@ module Vapi
     #       * :items (Hash{String => Object})
     #       * :properties (Hash{String => Object})
     #       * :description (String)
+    #       * :pattern (String)
+    #       * :format (Vapi::JsonSchemaFormat)
     #       * :required (Array<String>)
     #       * :enum (Array<String>)
+    #       * :title (String)
     #     * :timeout_seconds (Float)
+    #   * :structured_data_multi_plan (Array<Vapi::StructuredDataMultiPlan>)
     #   * :success_evaluation_plan (Hash)
     #     * :rubric (Vapi::SuccessEvaluationPlanRubric)
     #     * :messages (Array<Hash{String => Object}>)
     #     * :enabled (Boolean)
     #     * :timeout_seconds (Float)
     # @param artifact_plan [Hash] This is the plan for artifacts generated during assistant's calls. Stored in
-    #  `call.artifact`.
-    #  Note: `recordingEnabled` is currently at the root level. It will be moved to
-    #  `artifactPlan` in the future, but will remain backwards compatible.Request of type Vapi::ArtifactPlan, as a Hash
+    #  `call.artifact`.Request of type Vapi::ArtifactPlan, as a Hash
     #   * :recording_enabled (Boolean)
+    #   * :recording_format (Vapi::ArtifactPlanRecordingFormat)
     #   * :video_recording_enabled (Boolean)
+    #   * :pcap_enabled (Boolean)
+    #   * :pcap_s_3_path_prefix (String)
     #   * :transcript_plan (Hash)
     #     * :enabled (Boolean)
     #     * :assistant_name (String)
@@ -785,7 +920,9 @@ module Vapi
     #  remain backwards compatible.Request of type Vapi::MessagePlan, as a Hash
     #   * :idle_messages (Array<String>)
     #   * :idle_message_max_spoken_count (Float)
+    #   * :idle_message_reset_count_on_user_speech_enabled (Boolean)
     #   * :idle_timeout_seconds (Float)
+    #   * :silence_timeout_message (String)
     # @param start_speaking_plan [Hash] This is the plan for when the assistant should start talking.
     #  You should configure this if you're running into these issues:
     #  - The assistant is too slow to start talking after the customer is done
@@ -794,7 +931,8 @@ module Vapi
     #  speaking.
     #  - The assistant is so fast that it's actually interrupting the customer.Request of type Vapi::StartSpeakingPlan, as a Hash
     #   * :wait_seconds (Float)
-    #   * :smart_endpointing_enabled (Boolean)
+    #   * :smart_endpointing_enabled (Hash)
+    #   * :smart_endpointing_plan (Hash)
     #   * :custom_endpointing_rules (Array<Vapi::StartSpeakingPlanCustomEndpointingRulesItem>)
     #   * :transcription_endpointing_plan (Hash)
     #     * :on_punctuation_seconds (Float)
@@ -812,17 +950,18 @@ module Vapi
     #   * :num_words (Float)
     #   * :voice_seconds (Float)
     #   * :backoff_seconds (Float)
+    #   * :acknowledgement_phrases (Array<String>)
+    #   * :interruption_phrases (Array<String>)
     # @param monitor_plan [Hash] This is the plan for real-time monitoring of the assistant's calls.
     #  Usage:
     #  - To enable live listening of the assistant's calls, set
     #  `monitorPlan.listenEnabled` to `true`.
     #  - To enable live control of the assistant's calls, set
-    #  `monitorPlan.controlEnabled` to `true`.
-    #  Note, `serverMessages`, `clientMessages`, `serverUrl` and `serverUrlSecret` are
-    #  currently at the root level but will be moved to `monitorPlan` in the future.
-    #  Will remain backwards compatibleRequest of type Vapi::MonitorPlan, as a Hash
+    #  `monitorPlan.controlEnabled` to `true`.Request of type Vapi::MonitorPlan, as a Hash
     #   * :listen_enabled (Boolean)
+    #   * :listen_authentication_enabled (Boolean)
     #   * :control_enabled (Boolean)
+    #   * :control_authentication_enabled (Boolean)
     # @param credential_ids [Array<String>] These are the credentials that will be used for the assistant calls. By default,
     #  all the credentials are available for use in the call but you can provide a
     #  subset using this.
@@ -834,12 +973,19 @@ module Vapi
     #  3. org.serverUrlRequest of type Vapi::Server, as a Hash
     #   * :timeout_seconds (Float)
     #   * :url (String)
-    #   * :secret (String)
     #   * :headers (Hash{String => Object})
+    #   * :backoff_plan (Hash)
+    #     * :type (Hash{String => Object})
+    #     * :max_retries (Float)
+    #     * :base_delay_seconds (Float)
+    # @param keypad_input_plan [Hash] Request of type Vapi::KeypadInputPlan, as a Hash
+    #   * :enabled (Boolean)
+    #   * :timeout_seconds (Float)
+    #   * :delimiters (Vapi::KeypadInputPlanDelimiters)
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Assistant]
-    def update(id:, transcriber: nil, model: nil, voice: nil, first_message: nil, first_message_mode: nil,
-               hipaa_enabled: nil, client_messages: nil, server_messages: nil, silence_timeout_seconds: nil, max_duration_seconds: nil, background_sound: nil, background_denoising_enabled: nil, model_output_in_messages_enabled: nil, transport_configurations: nil, credentials: nil, name: nil, voicemail_detection: nil, voicemail_message: nil, end_call_message: nil, end_call_phrases: nil, metadata: nil, analysis_plan: nil, artifact_plan: nil, message_plan: nil, start_speaking_plan: nil, stop_speaking_plan: nil, monitor_plan: nil, credential_ids: nil, server: nil, request_options: nil)
+    def update(id:, transcriber: nil, model: nil, voice: nil, first_message: nil,
+               first_message_interruptions_enabled: nil, first_message_mode: nil, voicemail_detection: nil, client_messages: nil, server_messages: nil, silence_timeout_seconds: nil, max_duration_seconds: nil, background_sound: nil, background_denoising_enabled: nil, model_output_in_messages_enabled: nil, transport_configurations: nil, observability_plan: nil, credentials: nil, hooks: nil, name: nil, voicemail_message: nil, end_call_message: nil, end_call_phrases: nil, compliance_plan: nil, metadata: nil, background_speech_denoising_plan: nil, analysis_plan: nil, artifact_plan: nil, message_plan: nil, start_speaking_plan: nil, stop_speaking_plan: nil, monitor_plan: nil, credential_ids: nil, server: nil, keypad_input_plan: nil, request_options: nil)
       Async do
         response = @request_client.conn.patch do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -858,8 +1004,9 @@ module Vapi
             model: model,
             voice: voice,
             firstMessage: first_message,
+            firstMessageInterruptionsEnabled: first_message_interruptions_enabled,
             firstMessageMode: first_message_mode,
-            hipaaEnabled: hipaa_enabled,
+            voicemailDetection: voicemail_detection,
             clientMessages: client_messages,
             serverMessages: server_messages,
             silenceTimeoutSeconds: silence_timeout_seconds,
@@ -868,13 +1015,16 @@ module Vapi
             backgroundDenoisingEnabled: background_denoising_enabled,
             modelOutputInMessagesEnabled: model_output_in_messages_enabled,
             transportConfigurations: transport_configurations,
+            observabilityPlan: observability_plan,
             credentials: credentials,
+            hooks: hooks,
             name: name,
-            voicemailDetection: voicemail_detection,
             voicemailMessage: voicemail_message,
             endCallMessage: end_call_message,
             endCallPhrases: end_call_phrases,
+            compliancePlan: compliance_plan,
             metadata: metadata,
+            backgroundSpeechDenoisingPlan: background_speech_denoising_plan,
             analysisPlan: analysis_plan,
             artifactPlan: artifact_plan,
             messagePlan: message_plan,
@@ -882,7 +1032,8 @@ module Vapi
             stopSpeakingPlan: stop_speaking_plan,
             monitorPlan: monitor_plan,
             credentialIds: credential_ids,
-            server: server
+            server: server,
+            keypadInputPlan: keypad_input_plan
           }.compact
           req.url "#{@request_client.get_url(request_options: request_options)}/assistant/#{id}"
         end