vapi_server_sdk 0.4.0 → 0.5.0

data/lib/vapi_server_sdk/types/server_message_status_update.rb

@@ -20,6 +20,9 @@ module Vapi
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
     attr_reader :phone_number
+    # @return [String] This is the type of the message. "status-update" is sent whenever the
+    #  `call.status` changes.
+    attr_reader :type
     # @return [Vapi::ServerMessageStatusUpdateStatus] This is the status of the call.
     attr_reader :status
     # @return [Vapi::ServerMessageStatusUpdateEndedReason] This is the reason the call ended. This is only sent if the status is "ended".
@@ -80,6 +83,8 @@ module Vapi
     #  This matches one of the following:
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
+    # @param type [String] This is the type of the message. "status-update" is sent whenever the
+    #  `call.status` changes.
     # @param status [Vapi::ServerMessageStatusUpdateStatus] This is the status of the call.
     # @param ended_reason [Vapi::ServerMessageStatusUpdateEndedReason] This is the reason the call ended. This is only sent if the status is "ended".
     # @param messages [Array<Vapi::ServerMessageStatusUpdateMessagesItem>] These are the conversation messages of the call. This is only sent if the status
@@ -117,9 +122,10 @@ module Vapi
     #  This will include any errors related to the "assistant-request" if one was made.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ServerMessageStatusUpdate]
-    def initialize(status:, phone_number: OMIT, ended_reason: OMIT, messages: OMIT, messages_open_ai_formatted: OMIT,
-                   destination: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT, call: OMIT, transcript: OMIT, summary: OMIT, inbound_phone_call_debugging_artifacts: OMIT, additional_properties: nil)
+    def initialize(type:, status:, phone_number: OMIT, ended_reason: OMIT, messages: OMIT,
+                   messages_open_ai_formatted: OMIT, destination: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT, call: OMIT, transcript: OMIT, summary: OMIT, inbound_phone_call_debugging_artifacts: OMIT, additional_properties: nil)
       @phone_number = phone_number if phone_number != OMIT
+      @type = type
       @status = status
       @ended_reason = ended_reason if ended_reason != OMIT
       @messages = messages if messages != OMIT
@@ -138,6 +144,7 @@ module Vapi
       @additional_properties = additional_properties
       @_field_set = {
         "phoneNumber": phone_number,
+        "type": type,
         "status": status,
         "endedReason": ended_reason,
         "messages": messages,
@@ -169,6 +176,7 @@ module Vapi
         phone_number = parsed_json["phoneNumber"].to_json
         phone_number = Vapi::ServerMessageStatusUpdatePhoneNumber.from_json(json_object: phone_number)
       end
+      type = parsed_json["type"]
       status = parsed_json["status"]
       ended_reason = parsed_json["endedReason"]
       messages = parsed_json["messages"]&.map do |item|
@@ -215,6 +223,7 @@ module Vapi
       inbound_phone_call_debugging_artifacts = parsed_json["inboundPhoneCallDebuggingArtifacts"]
       new(
         phone_number: phone_number,
+        type: type,
         status: status,
         ended_reason: ended_reason,
         messages: messages,
@@ -247,6 +256,7 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.phone_number.nil? || Vapi::ServerMessageStatusUpdatePhoneNumber.validate_raw(obj: obj.phone_number)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       obj.status.is_a?(Vapi::ServerMessageStatusUpdateStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
       obj.ended_reason&.is_a?(Vapi::ServerMessageStatusUpdateEndedReason) != false || raise("Passed value for field obj.ended_reason is not the expected type, validation failed.")
       obj.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")

data/lib/vapi_server_sdk/types/server_message_status_update_ended_reason.rb

@@ -3,7 +3,7 @@
 module Vapi
   # This is the reason the call ended. This is only sent if the status is "ended".
   class ServerMessageStatusUpdateEndedReason
-    ASSISTANT_NOT_INVALID = "assistant-not-invalid"
+    ASSISTANT_NOT_VALID = "assistant-not-valid"
     ASSISTANT_NOT_PROVIDED = "assistant-not-provided"
     CALL_START_ERROR_NEITHER_ASSISTANT_NOR_SERVER_SET = "call-start-error-neither-assistant-nor-server-set"
     ASSISTANT_REQUEST_FAILED = "assistant-request-failed"
@@ -14,6 +14,7 @@ module Vapi
     ASSISTANT_REQUEST_RETURNED_FORWARDING_PHONE_NUMBER = "assistant-request-returned-forwarding-phone-number"
     ASSISTANT_ENDED_CALL = "assistant-ended-call"
     ASSISTANT_SAID_END_CALL_PHRASE = "assistant-said-end-call-phrase"
+    ASSISTANT_ENDED_CALL_WITH_HANGUP_TASK = "assistant-ended-call-with-hangup-task"
     ASSISTANT_FORWARDED_CALL = "assistant-forwarded-call"
     ASSISTANT_JOIN_TIMED_OUT = "assistant-join-timed-out"
     CUSTOMER_BUSY = "customer-busy"
@@ -37,8 +38,10 @@ module Vapi
     PIPELINE_ERROR_RIME_AI_VOICE_FAILED = "pipeline-error-rime-ai-voice-failed"
     PIPELINE_ERROR_NEETS_VOICE_FAILED = "pipeline-error-neets-voice-failed"
     PIPELINE_ERROR_SMALLEST_AI_VOICE_FAILED = "pipeline-error-smallest-ai-voice-failed"
+    PIPELINE_ERROR_NEUPHONIC_VOICE_FAILED = "pipeline-error-neuphonic-voice-failed"
     PIPELINE_ERROR_DEEPGRAM_TRANSCRIBER_FAILED = "pipeline-error-deepgram-transcriber-failed"
     PIPELINE_ERROR_GLADIA_TRANSCRIBER_FAILED = "pipeline-error-gladia-transcriber-failed"
+    PIPELINE_ERROR_SPEECHMATICS_TRANSCRIBER_FAILED = "pipeline-error-speechmatics-transcriber-failed"
     PIPELINE_ERROR_ASSEMBLY_AI_TRANSCRIBER_FAILED = "pipeline-error-assembly-ai-transcriber-failed"
     PIPELINE_ERROR_TALKSCRIBER_TRANSCRIBER_FAILED = "pipeline-error-talkscriber-transcriber-failed"
     PIPELINE_ERROR_AZURE_SPEECH_TRANSCRIBER_FAILED = "pipeline-error-azure-speech-transcriber-failed"
@@ -66,6 +69,7 @@ module Vapi
     PIPELINE_ERROR_GROQ_LLM_FAILED = "pipeline-error-groq-llm-failed"
     PIPELINE_ERROR_GOOGLE_LLM_FAILED = "pipeline-error-google-llm-failed"
     PIPELINE_ERROR_XAI_LLM_FAILED = "pipeline-error-xai-llm-failed"
+    PIPELINE_ERROR_MISTRAL_LLM_FAILED = "pipeline-error-mistral-llm-failed"
     PIPELINE_ERROR_INFLECTION_AI_LLM_FAILED = "pipeline-error-inflection-ai-llm-failed"
     PIPELINE_ERROR_CEREBRAS_LLM_FAILED = "pipeline-error-cerebras-llm-failed"
     PIPELINE_ERROR_DEEP_SEEK_LLM_FAILED = "pipeline-error-deep-seek-llm-failed"
@@ -84,6 +88,11 @@ module Vapi
     PIPELINE_ERROR_XAI_403_MODEL_ACCESS_DENIED = "pipeline-error-xai-403-model-access-denied"
     PIPELINE_ERROR_XAI_429_EXCEEDED_QUOTA = "pipeline-error-xai-429-exceeded-quota"
     PIPELINE_ERROR_XAI_500_SERVER_ERROR = "pipeline-error-xai-500-server-error"
+    PIPELINE_ERROR_MISTRAL_400_BAD_REQUEST_VALIDATION_FAILED = "pipeline-error-mistral-400-bad-request-validation-failed"
+    PIPELINE_ERROR_MISTRAL_401_UNAUTHORIZED = "pipeline-error-mistral-401-unauthorized"
+    PIPELINE_ERROR_MISTRAL_403_MODEL_ACCESS_DENIED = "pipeline-error-mistral-403-model-access-denied"
+    PIPELINE_ERROR_MISTRAL_429_EXCEEDED_QUOTA = "pipeline-error-mistral-429-exceeded-quota"
+    PIPELINE_ERROR_MISTRAL_500_SERVER_ERROR = "pipeline-error-mistral-500-server-error"
     PIPELINE_ERROR_INFLECTION_AI_400_BAD_REQUEST_VALIDATION_FAILED = "pipeline-error-inflection-ai-400-bad-request-validation-failed"
     PIPELINE_ERROR_INFLECTION_AI_401_UNAUTHORIZED = "pipeline-error-inflection-ai-401-unauthorized"
     PIPELINE_ERROR_INFLECTION_AI_403_MODEL_ACCESS_DENIED = "pipeline-error-inflection-ai-403-model-access-denied"

data/lib/vapi_server_sdk/types/server_message_tool_calls.rb

@@ -17,6 +17,8 @@ module Vapi
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
     attr_reader :phone_number
+    # @return [String] This is the type of the message. "tool-calls" is sent to call a tool.
+    attr_reader :type
     # @return [Array<Vapi::ServerMessageToolCallsToolWithToolCallListItem>] This is the list of tools calls that the model is requesting along with the
     #  original tool configuration.
     attr_reader :tool_with_tool_call_list
@@ -59,6 +61,7 @@ module Vapi
     #  This matches one of the following:
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
+    # @param type [String] This is the type of the message. "tool-calls" is sent to call a tool.
     # @param tool_with_tool_call_list [Array<Vapi::ServerMessageToolCallsToolWithToolCallListItem>] This is the list of tools calls that the model is requesting along with the
     #  original tool configuration.
     # @param timestamp [String] This is the ISO-8601 formatted timestamp of when the message was sent.
@@ -84,9 +87,10 @@ module Vapi
     # @param tool_call_list [Array<Vapi::ToolCall>] This is the list of tool calls that the model is requesting.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ServerMessageToolCalls]
-    def initialize(tool_with_tool_call_list:, tool_call_list:, phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT,
-                   customer: OMIT, call: OMIT, additional_properties: nil)
+    def initialize(tool_with_tool_call_list:, tool_call_list:, phone_number: OMIT, type: OMIT, timestamp: OMIT, artifact: OMIT,
+                   assistant: OMIT, customer: OMIT, call: OMIT, additional_properties: nil)
       @phone_number = phone_number if phone_number != OMIT
+      @type = type if type != OMIT
       @tool_with_tool_call_list = tool_with_tool_call_list
       @timestamp = timestamp if timestamp != OMIT
       @artifact = artifact if artifact != OMIT
@@ -97,6 +101,7 @@ module Vapi
       @additional_properties = additional_properties
       @_field_set = {
         "phoneNumber": phone_number,
+        "type": type,
         "toolWithToolCallList": tool_with_tool_call_list,
         "timestamp": timestamp,
         "artifact": artifact,
@@ -122,6 +127,7 @@ module Vapi
         phone_number = parsed_json["phoneNumber"].to_json
         phone_number = Vapi::ServerMessageToolCallsPhoneNumber.from_json(json_object: phone_number)
       end
+      type = parsed_json["type"]
       tool_with_tool_call_list = parsed_json["toolWithToolCallList"]&.map do |item|
         item = item.to_json
         Vapi::ServerMessageToolCallsToolWithToolCallListItem.from_json(json_object: item)
@@ -157,6 +163,7 @@ module Vapi
       end
       new(
         phone_number: phone_number,
+        type: type,
         tool_with_tool_call_list: tool_with_tool_call_list,
         timestamp: timestamp,
         artifact: artifact,
@@ -183,6 +190,7 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.phone_number.nil? || Vapi::ServerMessageToolCallsPhoneNumber.validate_raw(obj: obj.phone_number)
+      obj.type&.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       obj.tool_with_tool_call_list.is_a?(Array) != false || raise("Passed value for field obj.tool_with_tool_call_list is not the expected type, validation failed.")
       obj.timestamp&.is_a?(String) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
       obj.artifact.nil? || Vapi::Artifact.validate_raw(obj: obj.artifact)

data/lib/vapi_server_sdk/types/server_message_transcript.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "server_message_transcript_phone_number"
+require_relative "server_message_transcript_type"
 require_relative "artifact"
 require_relative "create_assistant_dto"
 require_relative "create_customer_dto"
@@ -17,6 +18,9 @@ module Vapi
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
     attr_reader :phone_number
+    # @return [Vapi::ServerMessageTranscriptType] This is the type of the message. "transcript" is sent as transcriber outputs
+    #  partial or final transcript.
+    attr_reader :type
     # @return [String] This is the ISO-8601 formatted timestamp of when the message was sent.
     attr_reader :timestamp
     # @return [Vapi::Artifact] This is a live version of the `call.artifact`.
@@ -60,6 +64,8 @@ module Vapi
     #  This matches one of the following:
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
+    # @param type [Vapi::ServerMessageTranscriptType] This is the type of the message. "transcript" is sent as transcriber outputs
+    #  partial or final transcript.
     # @param timestamp [String] This is the ISO-8601 formatted timestamp of when the message was sent.
     # @param artifact [Vapi::Artifact] This is a live version of the `call.artifact`.
     #  This matches what is stored on `call.artifact` after the call.
@@ -85,9 +91,10 @@ module Vapi
     # @param transcript [String] This is the transcript content.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ServerMessageTranscript]
-    def initialize(role:, transcript_type:, transcript:, phone_number: OMIT, timestamp: OMIT, artifact: OMIT,
-                   assistant: OMIT, customer: OMIT, call: OMIT, additional_properties: nil)
+    def initialize(type:, role:, transcript_type:, transcript:, phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT,
+                   call: OMIT, additional_properties: nil)
       @phone_number = phone_number if phone_number != OMIT
+      @type = type
       @timestamp = timestamp if timestamp != OMIT
       @artifact = artifact if artifact != OMIT
       @assistant = assistant if assistant != OMIT
@@ -99,6 +106,7 @@ module Vapi
       @additional_properties = additional_properties
       @_field_set = {
         "phoneNumber": phone_number,
+        "type": type,
         "timestamp": timestamp,
         "artifact": artifact,
         "assistant": assistant,
@@ -125,6 +133,7 @@ module Vapi
         phone_number = parsed_json["phoneNumber"].to_json
         phone_number = Vapi::ServerMessageTranscriptPhoneNumber.from_json(json_object: phone_number)
       end
+      type = parsed_json["type"]
       timestamp = parsed_json["timestamp"]
       if parsed_json["artifact"].nil?
         artifact = nil
@@ -155,6 +164,7 @@ module Vapi
       transcript = parsed_json["transcript"]
       new(
         phone_number: phone_number,
+        type: type,
         timestamp: timestamp,
         artifact: artifact,
         assistant: assistant,
@@ -182,6 +192,7 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.phone_number.nil? || Vapi::ServerMessageTranscriptPhoneNumber.validate_raw(obj: obj.phone_number)
+      obj.type.is_a?(Vapi::ServerMessageTranscriptType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       obj.timestamp&.is_a?(String) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
       obj.artifact.nil? || Vapi::Artifact.validate_raw(obj: obj.artifact)
       obj.assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.assistant)

data/lib/vapi_server_sdk/types/server_message_transcript_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the type of the message. "transcript" is sent as transcriber outputs
+  #  partial or final transcript.
+  class ServerMessageTranscriptType
+    TRANSCRIPT = "transcript"
+    TRANSCRIPT_TRANSCRIPT_TYPE_FINAL = "transcript[transcriptType='final']"
+  end
+end

data/lib/vapi_server_sdk/types/server_message_transfer_destination_request.rb

@@ -15,6 +15,9 @@ module Vapi
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
     attr_reader :phone_number
+    # @return [String] This is the type of the message. "transfer-destination-request" is sent when the
+    #  model is requesting transfer but destination is unknown.
+    attr_reader :type
     # @return [String] This is the ISO-8601 formatted timestamp of when the message was sent.
     attr_reader :timestamp
     # @return [Vapi::Artifact] This is a live version of the `call.artifact`.
@@ -52,6 +55,8 @@ module Vapi
     #  This matches one of the following:
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
+    # @param type [String] This is the type of the message. "transfer-destination-request" is sent when the
+    #  model is requesting transfer but destination is unknown.
     # @param timestamp [String] This is the ISO-8601 formatted timestamp of when the message was sent.
     # @param artifact [Vapi::Artifact] This is a live version of the `call.artifact`.
     #  This matches what is stored on `call.artifact` after the call.
@@ -74,9 +79,10 @@ module Vapi
     #  especially after the call is ended, use GET /call/:id.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ServerMessageTransferDestinationRequest]
-    def initialize(phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT, call: OMIT,
-                   additional_properties: nil)
+    def initialize(type:, phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT,
+                   call: OMIT, additional_properties: nil)
       @phone_number = phone_number if phone_number != OMIT
+      @type = type
       @timestamp = timestamp if timestamp != OMIT
       @artifact = artifact if artifact != OMIT
       @assistant = assistant if assistant != OMIT
@@ -85,6 +91,7 @@ module Vapi
       @additional_properties = additional_properties
       @_field_set = {
         "phoneNumber": phone_number,
+        "type": type,
         "timestamp": timestamp,
         "artifact": artifact,
         "assistant": assistant,
@@ -109,6 +116,7 @@ module Vapi
         phone_number = parsed_json["phoneNumber"].to_json
         phone_number = Vapi::ServerMessageTransferDestinationRequestPhoneNumber.from_json(json_object: phone_number)
       end
+      type = parsed_json["type"]
       timestamp = parsed_json["timestamp"]
       if parsed_json["artifact"].nil?
         artifact = nil
@@ -136,6 +144,7 @@ module Vapi
       end
       new(
         phone_number: phone_number,
+        type: type,
         timestamp: timestamp,
         artifact: artifact,
         assistant: assistant,
@@ -161,6 +170,7 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.phone_number.nil? || Vapi::ServerMessageTransferDestinationRequestPhoneNumber.validate_raw(obj: obj.phone_number)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       obj.timestamp&.is_a?(String) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
       obj.artifact.nil? || Vapi::Artifact.validate_raw(obj: obj.artifact)
       obj.assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.assistant)

data/lib/vapi_server_sdk/types/server_message_transfer_update.rb

@@ -16,6 +16,9 @@ module Vapi
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
     attr_reader :phone_number
+    # @return [String] This is the type of the message. "transfer-update" is sent whenever a transfer
+    #  happens.
+    attr_reader :type
     # @return [Vapi::ServerMessageTransferUpdateDestination] This is the destination of the transfer.
     attr_reader :destination
     # @return [String] This is the ISO-8601 formatted timestamp of when the message was sent.
@@ -65,6 +68,8 @@ module Vapi
     #  This matches one of the following:
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
+    # @param type [String] This is the type of the message. "transfer-update" is sent whenever a transfer
+    #  happens.
     # @param destination [Vapi::ServerMessageTransferUpdateDestination] This is the destination of the transfer.
     # @param timestamp [String] This is the ISO-8601 formatted timestamp of when the message was sent.
     # @param artifact [Vapi::Artifact] This is a live version of the `call.artifact`.
@@ -94,9 +99,10 @@ module Vapi
     # @param from_step_record [Hash{String => Object}] This is the step that the conversation moved from. =
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ServerMessageTransferUpdate]
-    def initialize(phone_number: OMIT, destination: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT,
+    def initialize(type:, phone_number: OMIT, destination: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT,
                    customer: OMIT, call: OMIT, to_assistant: OMIT, from_assistant: OMIT, to_step_record: OMIT, from_step_record: OMIT, additional_properties: nil)
       @phone_number = phone_number if phone_number != OMIT
+      @type = type
       @destination = destination if destination != OMIT
       @timestamp = timestamp if timestamp != OMIT
       @artifact = artifact if artifact != OMIT
@@ -110,6 +116,7 @@ module Vapi
       @additional_properties = additional_properties
       @_field_set = {
         "phoneNumber": phone_number,
+        "type": type,
         "destination": destination,
         "timestamp": timestamp,
         "artifact": artifact,
@@ -138,6 +145,7 @@ module Vapi
         phone_number = parsed_json["phoneNumber"].to_json
         phone_number = Vapi::ServerMessageTransferUpdatePhoneNumber.from_json(json_object: phone_number)
       end
+      type = parsed_json["type"]
       if parsed_json["destination"].nil?
         destination = nil
       else
@@ -185,6 +193,7 @@ module Vapi
       from_step_record = parsed_json["fromStepRecord"]
       new(
         phone_number: phone_number,
+        type: type,
         destination: destination,
         timestamp: timestamp,
         artifact: artifact,
@@ -214,6 +223,7 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.phone_number.nil? || Vapi::ServerMessageTransferUpdatePhoneNumber.validate_raw(obj: obj.phone_number)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       obj.destination.nil? || Vapi::ServerMessageTransferUpdateDestination.validate_raw(obj: obj.destination)
       obj.timestamp&.is_a?(String) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
       obj.artifact.nil? || Vapi::Artifact.validate_raw(obj: obj.artifact)

data/lib/vapi_server_sdk/types/server_message_user_interrupted.rb

@@ -15,6 +15,9 @@ module Vapi
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
     attr_reader :phone_number
+    # @return [String] This is the type of the message. "user-interrupted" is sent when the user
+    #  interrupts the assistant.
+    attr_reader :type
     # @return [String] This is the ISO-8601 formatted timestamp of when the message was sent.
     attr_reader :timestamp
     # @return [Vapi::Artifact] This is a live version of the `call.artifact`.
@@ -52,6 +55,8 @@ module Vapi
     #  This matches one of the following:
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
+    # @param type [String] This is the type of the message. "user-interrupted" is sent when the user
+    #  interrupts the assistant.
     # @param timestamp [String] This is the ISO-8601 formatted timestamp of when the message was sent.
     # @param artifact [Vapi::Artifact] This is a live version of the `call.artifact`.
     #  This matches what is stored on `call.artifact` after the call.
@@ -74,9 +79,10 @@ module Vapi
     #  especially after the call is ended, use GET /call/:id.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ServerMessageUserInterrupted]
-    def initialize(phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT, call: OMIT,
-                   additional_properties: nil)
+    def initialize(type:, phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT,
+                   call: OMIT, additional_properties: nil)
       @phone_number = phone_number if phone_number != OMIT
+      @type = type
       @timestamp = timestamp if timestamp != OMIT
       @artifact = artifact if artifact != OMIT
       @assistant = assistant if assistant != OMIT
@@ -85,6 +91,7 @@ module Vapi
       @additional_properties = additional_properties
       @_field_set = {
         "phoneNumber": phone_number,
+        "type": type,
         "timestamp": timestamp,
         "artifact": artifact,
         "assistant": assistant,
@@ -108,6 +115,7 @@ module Vapi
         phone_number = parsed_json["phoneNumber"].to_json
         phone_number = Vapi::ServerMessageUserInterruptedPhoneNumber.from_json(json_object: phone_number)
       end
+      type = parsed_json["type"]
       timestamp = parsed_json["timestamp"]
       if parsed_json["artifact"].nil?
         artifact = nil
@@ -135,6 +143,7 @@ module Vapi
       end
       new(
         phone_number: phone_number,
+        type: type,
         timestamp: timestamp,
         artifact: artifact,
         assistant: assistant,
@@ -159,6 +168,7 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.phone_number.nil? || Vapi::ServerMessageUserInterruptedPhoneNumber.validate_raw(obj: obj.phone_number)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       obj.timestamp&.is_a?(String) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
       obj.artifact.nil? || Vapi::Artifact.validate_raw(obj: obj.artifact)
       obj.assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.assistant)

data/lib/vapi_server_sdk/types/server_message_voice_input.rb

@@ -15,6 +15,9 @@ module Vapi
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
     attr_reader :phone_number
+    # @return [String] This is the type of the message. "voice-input" is sent when a generation is
+    #  requested from voice provider.
+    attr_reader :type
     # @return [String] This is the ISO-8601 formatted timestamp of when the message was sent.
     attr_reader :timestamp
     # @return [Vapi::Artifact] This is a live version of the `call.artifact`.
@@ -54,6 +57,8 @@ module Vapi
     #  This matches one of the following:
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
+    # @param type [String] This is the type of the message. "voice-input" is sent when a generation is
+    #  requested from voice provider.
     # @param timestamp [String] This is the ISO-8601 formatted timestamp of when the message was sent.
     # @param artifact [Vapi::Artifact] This is a live version of the `call.artifact`.
     #  This matches what is stored on `call.artifact` after the call.
@@ -77,9 +82,10 @@ module Vapi
     # @param input [String] This is the voice input content
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ServerMessageVoiceInput]
-    def initialize(input:, phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT,
+    def initialize(type:, input:, phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT,
                    call: OMIT, additional_properties: nil)
       @phone_number = phone_number if phone_number != OMIT
+      @type = type
       @timestamp = timestamp if timestamp != OMIT
       @artifact = artifact if artifact != OMIT
       @assistant = assistant if assistant != OMIT
@@ -89,6 +95,7 @@ module Vapi
       @additional_properties = additional_properties
       @_field_set = {
         "phoneNumber": phone_number,
+        "type": type,
         "timestamp": timestamp,
         "artifact": artifact,
         "assistant": assistant,
@@ -113,6 +120,7 @@ module Vapi
         phone_number = parsed_json["phoneNumber"].to_json
         phone_number = Vapi::ServerMessageVoiceInputPhoneNumber.from_json(json_object: phone_number)
       end
+      type = parsed_json["type"]
       timestamp = parsed_json["timestamp"]
       if parsed_json["artifact"].nil?
         artifact = nil
@@ -141,6 +149,7 @@ module Vapi
       input = parsed_json["input"]
       new(
         phone_number: phone_number,
+        type: type,
         timestamp: timestamp,
         artifact: artifact,
         assistant: assistant,
@@ -166,6 +175,7 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.phone_number.nil? || Vapi::ServerMessageVoiceInputPhoneNumber.validate_raw(obj: obj.phone_number)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       obj.timestamp&.is_a?(String) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
       obj.artifact.nil? || Vapi::Artifact.validate_raw(obj: obj.artifact)
       obj.assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.assistant)

data/lib/vapi_server_sdk/types/server_message_voice_request.rb

@@ -15,6 +15,28 @@ module Vapi
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
     attr_reader :phone_number
+    # @return [String] This is the type of the message. "voice-request" is sent when using
+    #  `assistant.voice={ "type": "custom-voice" }`.
+    #  Here is what the request will look like:
+    #  POST https://{assistant.voice.server.url}
+    #  Content-Type: application/json
+    #  {
+    #  "messsage": {
+    #  "type": "voice-request",
+    #  "text": "Hello, world!",
+    #  "sampleRate": 24000,
+    #  ...other metadata about the call...
+    #  }
+    #  }
+    #  The expected response is 1-channel 16-bit raw PCM audio at the sample rate
+    #  specified in the request. Here is how the response will be piped to the
+    #  transport:
+    #  ```
+    #  response.on('data', (chunk: Buffer) => {
+    #  outputStream.write(chunk);
+    #  });
+    #  ```
+    attr_reader :type
     # @return [String] This is the ISO-8601 formatted timestamp of when the message was sent.
     attr_reader :timestamp
     # @return [Vapi::Artifact] This is a live version of the `call.artifact`.
@@ -56,6 +78,27 @@ module Vapi
     #  This matches one of the following:
     #  - `call.phoneNumber`,
     #  - `call.phoneNumberId`.
+    # @param type [String] This is the type of the message. "voice-request" is sent when using
+    #  `assistant.voice={ "type": "custom-voice" }`.
+    #  Here is what the request will look like:
+    #  POST https://{assistant.voice.server.url}
+    #  Content-Type: application/json
+    #  {
+    #  "messsage": {
+    #  "type": "voice-request",
+    #  "text": "Hello, world!",
+    #  "sampleRate": 24000,
+    #  ...other metadata about the call...
+    #  }
+    #  }
+    #  The expected response is 1-channel 16-bit raw PCM audio at the sample rate
+    #  specified in the request. Here is how the response will be piped to the
+    #  transport:
+    #  ```
+    #  response.on('data', (chunk: Buffer) => {
+    #  outputStream.write(chunk);
+    #  });
+    #  ```
     # @param timestamp [String] This is the ISO-8601 formatted timestamp of when the message was sent.
     # @param artifact [Vapi::Artifact] This is a live version of the `call.artifact`.
     #  This matches what is stored on `call.artifact` after the call.
@@ -80,9 +123,10 @@ module Vapi
     # @param sample_rate [Float] This is the sample rate to be synthesized.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ServerMessageVoiceRequest]
-    def initialize(text:, sample_rate:, phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT,
-                   customer: OMIT, call: OMIT, additional_properties: nil)
+    def initialize(type:, text:, sample_rate:, phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT,
+                   call: OMIT, additional_properties: nil)
       @phone_number = phone_number if phone_number != OMIT
+      @type = type
       @timestamp = timestamp if timestamp != OMIT
       @artifact = artifact if artifact != OMIT
       @assistant = assistant if assistant != OMIT
@@ -93,6 +137,7 @@ module Vapi
       @additional_properties = additional_properties
       @_field_set = {
         "phoneNumber": phone_number,
+        "type": type,
         "timestamp": timestamp,
         "artifact": artifact,
         "assistant": assistant,
@@ -118,6 +163,7 @@ module Vapi
         phone_number = parsed_json["phoneNumber"].to_json
         phone_number = Vapi::ServerMessageVoiceRequestPhoneNumber.from_json(json_object: phone_number)
       end
+      type = parsed_json["type"]
       timestamp = parsed_json["timestamp"]
       if parsed_json["artifact"].nil?
         artifact = nil
@@ -147,6 +193,7 @@ module Vapi
       sample_rate = parsed_json["sampleRate"]
       new(
         phone_number: phone_number,
+        type: type,
         timestamp: timestamp,
         artifact: artifact,
         assistant: assistant,
@@ -173,6 +220,7 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.phone_number.nil? || Vapi::ServerMessageVoiceRequestPhoneNumber.validate_raw(obj: obj.phone_number)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       obj.timestamp&.is_a?(String) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
       obj.artifact.nil? || Vapi::Artifact.validate_raw(obj: obj.artifact)
       obj.assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.assistant)