vapi_server_sdk 0.3.0 → 0.5.0

data/lib/vapi_server_sdk/types/cartesia_voice.rb

@@ -2,6 +2,7 @@
 
 require_relative "cartesia_voice_model"
 require_relative "cartesia_voice_language"
+require_relative "cartesia_experimental_controls"
 require_relative "chunk_plan"
 require_relative "fallback_plan"
 require "ostruct"
@@ -9,17 +10,19 @@ require "json"
 
 module Vapi
   class CartesiaVoice
+    # @return [String] The ID of the particular voice you want to use.
+    attr_reader :voice_id
     # @return [Vapi::CartesiaVoiceModel] This is the model that will be used. This is optional and will default to the
     #  correct model for the voiceId.
     attr_reader :model
     # @return [Vapi::CartesiaVoiceLanguage] This is the language that will be used. This is optional and will default to the
     #  correct language for the voiceId.
     attr_reader :language
+    # @return [Vapi::CartesiaExperimentalControls] Experimental controls for Cartesia voice generation
+    attr_reader :experimental_controls
     # @return [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
     #  provider.
     attr_reader :chunk_plan
-    # @return [String] This is the provider-specific ID that will be used.
-    attr_reader :voice_id
     # @return [Vapi::FallbackPlan] This is the plan for voice provider fallbacks in the event that the primary
     #  voice provider fails.
     attr_reader :fallback_plan
@@ -31,30 +34,33 @@ module Vapi
 
     OMIT = Object.new
 
+    # @param voice_id [String] The ID of the particular voice you want to use.
     # @param model [Vapi::CartesiaVoiceModel] This is the model that will be used. This is optional and will default to the
     #  correct model for the voiceId.
     # @param language [Vapi::CartesiaVoiceLanguage] This is the language that will be used. This is optional and will default to the
     #  correct language for the voiceId.
+    # @param experimental_controls [Vapi::CartesiaExperimentalControls] Experimental controls for Cartesia voice generation
     # @param chunk_plan [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
     #  provider.
-    # @param voice_id [String] This is the provider-specific ID that will be used.
     # @param fallback_plan [Vapi::FallbackPlan] This is the plan for voice provider fallbacks in the event that the primary
     #  voice provider fails.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::CartesiaVoice]
-    def initialize(voice_id:, model: OMIT, language: OMIT, chunk_plan: OMIT, fallback_plan: OMIT,
-                   additional_properties: nil)
+    def initialize(voice_id:, model: OMIT, language: OMIT, experimental_controls: OMIT, chunk_plan: OMIT,
+                   fallback_plan: OMIT, additional_properties: nil)
+      @voice_id = voice_id
       @model = model if model != OMIT
       @language = language if language != OMIT
+      @experimental_controls = experimental_controls if experimental_controls != OMIT
       @chunk_plan = chunk_plan if chunk_plan != OMIT
-      @voice_id = voice_id
       @fallback_plan = fallback_plan if fallback_plan != OMIT
       @additional_properties = additional_properties
       @_field_set = {
+        "voiceId": voice_id,
         "model": model,
         "language": language,
+        "experimentalControls": experimental_controls,
         "chunkPlan": chunk_plan,
-        "voiceId": voice_id,
         "fallbackPlan": fallback_plan
       }.reject do |_k, v|
         v == OMIT
@@ -68,15 +74,21 @@ module Vapi
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
+      voice_id = parsed_json["voiceId"]
       model = parsed_json["model"]
       language = parsed_json["language"]
+      if parsed_json["experimentalControls"].nil?
+        experimental_controls = nil
+      else
+        experimental_controls = parsed_json["experimentalControls"].to_json
+        experimental_controls = Vapi::CartesiaExperimentalControls.from_json(json_object: experimental_controls)
+      end
       if parsed_json["chunkPlan"].nil?
         chunk_plan = nil
       else
         chunk_plan = parsed_json["chunkPlan"].to_json
         chunk_plan = Vapi::ChunkPlan.from_json(json_object: chunk_plan)
       end
-      voice_id = parsed_json["voiceId"]
       if parsed_json["fallbackPlan"].nil?
         fallback_plan = nil
       else
@@ -84,10 +96,11 @@ module Vapi
         fallback_plan = Vapi::FallbackPlan.from_json(json_object: fallback_plan)
       end
       new(
+        voice_id: voice_id,
         model: model,
         language: language,
+        experimental_controls: experimental_controls,
         chunk_plan: chunk_plan,
-        voice_id: voice_id,
         fallback_plan: fallback_plan,
         additional_properties: struct
       )
@@ -107,10 +120,11 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
+      obj.voice_id.is_a?(String) != false || raise("Passed value for field obj.voice_id is not the expected type, validation failed.")
       obj.model&.is_a?(Vapi::CartesiaVoiceModel) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
       obj.language&.is_a?(Vapi::CartesiaVoiceLanguage) != false || raise("Passed value for field obj.language is not the expected type, validation failed.")
+      obj.experimental_controls.nil? || Vapi::CartesiaExperimentalControls.validate_raw(obj: obj.experimental_controls)
       obj.chunk_plan.nil? || Vapi::ChunkPlan.validate_raw(obj: obj.chunk_plan)
-      obj.voice_id.is_a?(String) != false || raise("Passed value for field obj.voice_id is not the expected type, validation failed.")
       obj.fallback_plan.nil? || Vapi::FallbackPlan.validate_raw(obj: obj.fallback_plan)
     end
   end

data/lib/vapi_server_sdk/types/chat_completion_message.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative "chat_completion_message_metadata"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ChatCompletionMessage
+    # @return [Hash{String => Object}]
+    attr_reader :role
+    # @return [String]
+    attr_reader :content
+    # @return [Vapi::ChatCompletionMessageMetadata]
+    attr_reader :metadata
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param role [Hash{String => Object}]
+    # @param content [String]
+    # @param metadata [Vapi::ChatCompletionMessageMetadata]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ChatCompletionMessage]
+    def initialize(role:, content: OMIT, metadata: OMIT, additional_properties: nil)
+      @role = role
+      @content = content if content != OMIT
+      @metadata = metadata if metadata != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "role": role, "content": content, "metadata": metadata }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ChatCompletionMessage
+    #
+    # @param json_object [String]
+    # @return [Vapi::ChatCompletionMessage]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      role = parsed_json["role"]
+      content = parsed_json["content"]
+      if parsed_json["metadata"].nil?
+        metadata = nil
+      else
+        metadata = parsed_json["metadata"].to_json
+        metadata = Vapi::ChatCompletionMessageMetadata.from_json(json_object: metadata)
+      end
+      new(
+        role: role,
+        content: content,
+        metadata: metadata,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ChatCompletionMessage to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.role.is_a?(Hash) != false || raise("Passed value for field obj.role is not the expected type, validation failed.")
+      obj.content&.is_a?(String) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
+      obj.metadata.nil? || Vapi::ChatCompletionMessageMetadata.validate_raw(obj: obj.metadata)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/chat_completion_message_metadata.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class ChatCompletionMessageMetadata
+    # @return [String]
+    attr_reader :task_name
+    # @return [String]
+    attr_reader :task_type
+    # @return [String]
+    attr_reader :task_output
+    # @return [Hash{String => Object}]
+    attr_reader :task_state
+    # @return [Array<String>]
+    attr_reader :node_trace
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param task_name [String]
+    # @param task_type [String]
+    # @param task_output [String]
+    # @param task_state [Hash{String => Object}]
+    # @param node_trace [Array<String>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ChatCompletionMessageMetadata]
+    def initialize(task_name:, task_type:, task_output:, task_state: OMIT, node_trace: OMIT, additional_properties: nil)
+      @task_name = task_name
+      @task_type = task_type
+      @task_output = task_output
+      @task_state = task_state if task_state != OMIT
+      @node_trace = node_trace if node_trace != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "taskName": task_name,
+        "taskType": task_type,
+        "taskOutput": task_output,
+        "taskState": task_state,
+        "nodeTrace": node_trace
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ChatCompletionMessageMetadata
+    #
+    # @param json_object [String]
+    # @return [Vapi::ChatCompletionMessageMetadata]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      task_name = parsed_json["taskName"]
+      task_type = parsed_json["taskType"]
+      task_output = parsed_json["taskOutput"]
+      task_state = parsed_json["taskState"]
+      node_trace = parsed_json["nodeTrace"]
+      new(
+        task_name: task_name,
+        task_type: task_type,
+        task_output: task_output,
+        task_state: task_state,
+        node_trace: node_trace,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ChatCompletionMessageMetadata to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.task_name.is_a?(String) != false || raise("Passed value for field obj.task_name is not the expected type, validation failed.")
+      obj.task_type.is_a?(String) != false || raise("Passed value for field obj.task_type is not the expected type, validation failed.")
+      obj.task_output.is_a?(String) != false || raise("Passed value for field obj.task_output is not the expected type, validation failed.")
+      obj.task_state&.is_a?(Hash) != false || raise("Passed value for field obj.task_state is not the expected type, validation failed.")
+      obj.node_trace&.is_a?(Array) != false || raise("Passed value for field obj.node_trace is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/chat_completions_dto.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative "chat_completion_message"
+require_relative "create_workflow_dto"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ChatCompletionsDto
+    # @return [Array<Vapi::ChatCompletionMessage>]
+    attr_reader :messages
+    # @return [String]
+    attr_reader :workflow_id
+    # @return [Vapi::CreateWorkflowDto]
+    attr_reader :workflow
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param messages [Array<Vapi::ChatCompletionMessage>]
+    # @param workflow_id [String]
+    # @param workflow [Vapi::CreateWorkflowDto]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ChatCompletionsDto]
+    def initialize(messages:, workflow_id: OMIT, workflow: OMIT, additional_properties: nil)
+      @messages = messages
+      @workflow_id = workflow_id if workflow_id != OMIT
+      @workflow = workflow if workflow != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "messages": messages, "workflowId": workflow_id, "workflow": workflow }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ChatCompletionsDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::ChatCompletionsDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      messages = parsed_json["messages"]&.map do |item|
+        item = item.to_json
+        Vapi::ChatCompletionMessage.from_json(json_object: item)
+      end
+      workflow_id = parsed_json["workflowId"]
+      if parsed_json["workflow"].nil?
+        workflow = nil
+      else
+        workflow = parsed_json["workflow"].to_json
+        workflow = Vapi::CreateWorkflowDto.from_json(json_object: workflow)
+      end
+      new(
+        messages: messages,
+        workflow_id: workflow_id,
+        workflow: workflow,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ChatCompletionsDto to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.messages.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
+      obj.workflow_id&.is_a?(String) != false || raise("Passed value for field obj.workflow_id is not the expected type, validation failed.")
+      obj.workflow.nil? || Vapi::CreateWorkflowDto.validate_raw(obj: obj.workflow)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/client_inbound_message_end_call.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class ClientInboundMessageEndCall
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ClientInboundMessageEndCall]
+    def initialize(additional_properties: nil)
+      @additional_properties = additional_properties
+      @_field_set = {}
+    end
+
+    # Deserialize a JSON object to an instance of ClientInboundMessageEndCall
+    #
+    # @param json_object [String]
+    # @return [Vapi::ClientInboundMessageEndCall]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      new(additional_properties: struct)
+    end
+
+    # Serialize an instance of ClientInboundMessageEndCall to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:); end
+  end
+end

data/lib/vapi_server_sdk/types/client_inbound_message_message.rb

@@ -4,6 +4,7 @@ require "json"
 require_relative "client_inbound_message_add_message"
 require_relative "client_inbound_message_control"
 require_relative "client_inbound_message_say"
+require_relative "client_inbound_message_end_call"
 require_relative "client_inbound_message_transfer"
 
 module Vapi
@@ -39,6 +40,8 @@ module Vapi
                  Vapi::ClientInboundMessageControl.from_json(json_object: json_object)
                when "say"
                  Vapi::ClientInboundMessageSay.from_json(json_object: json_object)
+               when "end-call"
+                 Vapi::ClientInboundMessageEndCall.from_json(json_object: json_object)
                when "transfer"
                  Vapi::ClientInboundMessageTransfer.from_json(json_object: json_object)
                else
@@ -58,6 +61,8 @@ module Vapi
         { **@member.to_json, type: @discriminant }.to_json
       when "say"
         { **@member.to_json, type: @discriminant }.to_json
+      when "end-call"
+        { **@member.to_json, type: @discriminant }.to_json
       when "transfer"
         { **@member.to_json, type: @discriminant }.to_json
       else
@@ -80,6 +85,8 @@ module Vapi
         Vapi::ClientInboundMessageControl.validate_raw(obj: obj)
       when "say"
         Vapi::ClientInboundMessageSay.validate_raw(obj: obj)
+      when "end-call"
+        Vapi::ClientInboundMessageEndCall.validate_raw(obj: obj)
       when "transfer"
         Vapi::ClientInboundMessageTransfer.validate_raw(obj: obj)
       else
@@ -113,6 +120,12 @@ module Vapi
       new(member: member, discriminant: "say")
     end
 
+    # @param member [Vapi::ClientInboundMessageEndCall]
+    # @return [Vapi::ClientInboundMessageMessage]
+    def self.end_call(member:)
+      new(member: member, discriminant: "end-call")
+    end
+
     # @param member [Vapi::ClientInboundMessageTransfer]
     # @return [Vapi::ClientInboundMessageMessage]
     def self.transfer(member:)

data/lib/vapi_server_sdk/types/client_inbound_message_transfer.rb

@@ -8,6 +8,8 @@ module Vapi
   class ClientInboundMessageTransfer
     # @return [Vapi::ClientInboundMessageTransferDestination] This is the destination to transfer the call to.
     attr_reader :destination
+    # @return [String] This is the content to say.
+    attr_reader :content
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -17,12 +19,14 @@ module Vapi
     OMIT = Object.new
 
     # @param destination [Vapi::ClientInboundMessageTransferDestination] This is the destination to transfer the call to.
+    # @param content [String] This is the content to say.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ClientInboundMessageTransfer]
-    def initialize(destination: OMIT, additional_properties: nil)
+    def initialize(destination: OMIT, content: OMIT, additional_properties: nil)
       @destination = destination if destination != OMIT
+      @content = content if content != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "destination": destination }.reject do |_k, v|
+      @_field_set = { "destination": destination, "content": content }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -40,7 +44,12 @@ module Vapi
         destination = parsed_json["destination"].to_json
         destination = Vapi::ClientInboundMessageTransferDestination.from_json(json_object: destination)
       end
-      new(destination: destination, additional_properties: struct)
+      content = parsed_json["content"]
+      new(
+        destination: destination,
+        content: content,
+        additional_properties: struct
+      )
     end
 
     # Serialize an instance of ClientInboundMessageTransfer to a JSON object
@@ -58,6 +67,7 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.destination.nil? || Vapi::ClientInboundMessageTransferDestination.validate_raw(obj: obj.destination)
+      obj.content&.is_a?(String) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/client_message_conversation_update.rb

@@ -7,6 +7,9 @@ require "json"
 
 module Vapi
   class ClientMessageConversationUpdate
+    # @return [String] This is the type of the message. "conversation-update" is sent when an update is
+    #  committed to the conversation history.
+    attr_reader :type
     # @return [Array<Vapi::ClientMessageConversationUpdateMessagesItem>] This is the most up-to-date conversation history at the time the message is
     #  sent.
     attr_reader :messages
@@ -21,17 +24,24 @@ module Vapi
 
     OMIT = Object.new
 
+    # @param type [String] This is the type of the message. "conversation-update" is sent when an update is
+    #  committed to the conversation history.
     # @param messages [Array<Vapi::ClientMessageConversationUpdateMessagesItem>] This is the most up-to-date conversation history at the time the message is
     #  sent.
     # @param messages_open_ai_formatted [Array<Vapi::OpenAiMessage>] This is the most up-to-date conversation history at the time the message is
     #  sent, formatted for OpenAI.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ClientMessageConversationUpdate]
-    def initialize(messages_open_ai_formatted:, messages: OMIT, additional_properties: nil)
+    def initialize(type:, messages_open_ai_formatted:, messages: OMIT, additional_properties: nil)
+      @type = type
       @messages = messages if messages != OMIT
       @messages_open_ai_formatted = messages_open_ai_formatted
       @additional_properties = additional_properties
-      @_field_set = { "messages": messages, "messagesOpenAIFormatted": messages_open_ai_formatted }.reject do |_k, v|
+      @_field_set = {
+        "type": type,
+        "messages": messages,
+        "messagesOpenAIFormatted": messages_open_ai_formatted
+      }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -43,6 +53,7 @@ module Vapi
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
       messages = parsed_json["messages"]&.map do |item|
         item = item.to_json
         Vapi::ClientMessageConversationUpdateMessagesItem.from_json(json_object: item)
@@ -52,6 +63,7 @@ module Vapi
         Vapi::OpenAiMessage.from_json(json_object: item)
       end
       new(
+        type: type,
         messages: messages,
         messages_open_ai_formatted: messages_open_ai_formatted,
         additional_properties: struct
@@ -72,6 +84,7 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type 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.")
       obj.messages_open_ai_formatted.is_a?(Array) != false || raise("Passed value for field obj.messages_open_ai_formatted is not the expected type, validation failed.")
     end

data/lib/vapi_server_sdk/types/client_message_hang.rb

@@ -5,6 +5,13 @@ require "json"
 
 module Vapi
   class ClientMessageHang
+    # @return [String] This is the type of the message. "hang" is sent when the assistant is hanging
+    #  due to a delay. The delay can be caused by many factors, such as:
+    #  - the model is too slow to respond
+    #  - the voice is too slow to respond
+    #  - the tool call is still waiting for a response from your server
+    #  - etc.
+    attr_reader :type
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -13,11 +20,18 @@ module Vapi
 
     OMIT = Object.new
 
+    # @param type [String] This is the type of the message. "hang" is sent when the assistant is hanging
+    #  due to a delay. The delay can be caused by many factors, such as:
+    #  - the model is too slow to respond
+    #  - the voice is too slow to respond
+    #  - the tool call is still waiting for a response from your server
+    #  - etc.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ClientMessageHang]
-    def initialize(additional_properties: nil)
+    def initialize(type:, additional_properties: nil)
+      @type = type
       @additional_properties = additional_properties
-      @_field_set = {}
+      @_field_set = { "type": type }
     end
 
     # Deserialize a JSON object to an instance of ClientMessageHang
@@ -26,7 +40,9 @@ module Vapi
     # @return [Vapi::ClientMessageHang]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
-      new(additional_properties: struct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      new(type: type, additional_properties: struct)
     end
 
     # Serialize an instance of ClientMessageHang to a JSON object
@@ -42,6 +58,8 @@ module Vapi
     #
     # @param obj [Object]
     # @return [Void]
-    def self.validate_raw(obj:); end
+    def self.validate_raw(obj:)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+    end
   end
 end