vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/client_message_message.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "client_message_conversation_update"
+require_relative "client_message_hang"
+require_relative "client_message_metadata"
+require_relative "client_message_model_output"
+require_relative "client_message_speech_update"
+require_relative "client_message_transcript"
+require_relative "client_message_tool_calls"
+require_relative "client_message_tool_calls_result"
+require_relative "client_message_user_interrupted"
+require_relative "client_message_language_changed"
+require_relative "client_message_voice_input"
+
+module Vapi
+  # These are all the messages that can be sent to the client-side SDKs during the
+  #  call. Configure the messages you'd like to receive in
+  #  `assistant.clientMessages`.
+  class ClientMessageMessage
+    # @return [Object]
+    attr_reader :member
+    # @return [String]
+    attr_reader :discriminant
+
+    private_class_method :new
+    alias kind_of? is_a?
+
+    # @param member [Object]
+    # @param discriminant [String]
+    # @return [Vapi::ClientMessageMessage]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of ClientMessageMessage
+    #
+    # @param json_object [String]
+    # @return [Vapi::ClientMessageMessage]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "conversation-update"
+                 Vapi::ClientMessageConversationUpdate.from_json(json_object: json_object)
+               when "hang"
+                 Vapi::ClientMessageHang.from_json(json_object: json_object)
+               when "metadata"
+                 Vapi::ClientMessageMetadata.from_json(json_object: json_object)
+               when "model-output"
+                 Vapi::ClientMessageModelOutput.from_json(json_object: json_object)
+               when "speech-update"
+                 Vapi::ClientMessageSpeechUpdate.from_json(json_object: json_object)
+               when "transcript"
+                 Vapi::ClientMessageTranscript.from_json(json_object: json_object)
+               when "tool-calls"
+                 Vapi::ClientMessageToolCalls.from_json(json_object: json_object)
+               when "tool-calls-result"
+                 Vapi::ClientMessageToolCallsResult.from_json(json_object: json_object)
+               when "user-interrupted"
+                 Vapi::ClientMessageUserInterrupted.from_json(json_object: json_object)
+               when "language-changed"
+                 Vapi::ClientMessageLanguageChanged.from_json(json_object: json_object)
+               when "voice-input"
+                 Vapi::ClientMessageVoiceInput.from_json(json_object: json_object)
+               else
+                 Vapi::ClientMessageConversationUpdate.from_json(json_object: json_object)
+               end
+      new(member: member, discriminant: struct.type)
+    end
+
+    # For Union Types, to_json functionality is delegated to the wrapped member.
+    #
+    # @return [String]
+    def to_json(*_args)
+      case @discriminant
+      when "conversation-update"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "hang"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "metadata"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "model-output"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "speech-update"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "transcript"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "tool-calls"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "tool-calls-result"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "user-interrupted"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "language-changed"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "voice-input"
+        { **@member.to_json, type: @discriminant }.to_json
+      else
+        { "type": @discriminant, value: @member }.to_json
+      end
+      @member.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:)
+      case obj.type
+      when "conversation-update"
+        Vapi::ClientMessageConversationUpdate.validate_raw(obj: obj)
+      when "hang"
+        Vapi::ClientMessageHang.validate_raw(obj: obj)
+      when "metadata"
+        Vapi::ClientMessageMetadata.validate_raw(obj: obj)
+      when "model-output"
+        Vapi::ClientMessageModelOutput.validate_raw(obj: obj)
+      when "speech-update"
+        Vapi::ClientMessageSpeechUpdate.validate_raw(obj: obj)
+      when "transcript"
+        Vapi::ClientMessageTranscript.validate_raw(obj: obj)
+      when "tool-calls"
+        Vapi::ClientMessageToolCalls.validate_raw(obj: obj)
+      when "tool-calls-result"
+        Vapi::ClientMessageToolCallsResult.validate_raw(obj: obj)
+      when "user-interrupted"
+        Vapi::ClientMessageUserInterrupted.validate_raw(obj: obj)
+      when "language-changed"
+        Vapi::ClientMessageLanguageChanged.validate_raw(obj: obj)
+      when "voice-input"
+        Vapi::ClientMessageVoiceInput.validate_raw(obj: obj)
+      else
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+
+    # For Union Types, is_a? functionality is delegated to the wrapped member.
+    #
+    # @param obj [Object]
+    # @return [Boolean]
+    def is_a?(obj)
+      @member.is_a?(obj)
+    end
+
+    # @param member [Vapi::ClientMessageConversationUpdate]
+    # @return [Vapi::ClientMessageMessage]
+    def self.conversation_update(member:)
+      new(member: member, discriminant: "conversation-update")
+    end
+
+    # @param member [Vapi::ClientMessageHang]
+    # @return [Vapi::ClientMessageMessage]
+    def self.hang(member:)
+      new(member: member, discriminant: "hang")
+    end
+
+    # @param member [Vapi::ClientMessageMetadata]
+    # @return [Vapi::ClientMessageMessage]
+    def self.metadata(member:)
+      new(member: member, discriminant: "metadata")
+    end
+
+    # @param member [Vapi::ClientMessageModelOutput]
+    # @return [Vapi::ClientMessageMessage]
+    def self.model_output(member:)
+      new(member: member, discriminant: "model-output")
+    end
+
+    # @param member [Vapi::ClientMessageSpeechUpdate]
+    # @return [Vapi::ClientMessageMessage]
+    def self.speech_update(member:)
+      new(member: member, discriminant: "speech-update")
+    end
+
+    # @param member [Vapi::ClientMessageTranscript]
+    # @return [Vapi::ClientMessageMessage]
+    def self.transcript(member:)
+      new(member: member, discriminant: "transcript")
+    end
+
+    # @param member [Vapi::ClientMessageToolCalls]
+    # @return [Vapi::ClientMessageMessage]
+    def self.tool_calls(member:)
+      new(member: member, discriminant: "tool-calls")
+    end
+
+    # @param member [Vapi::ClientMessageToolCallsResult]
+    # @return [Vapi::ClientMessageMessage]
+    def self.tool_calls_result(member:)
+      new(member: member, discriminant: "tool-calls-result")
+    end
+
+    # @param member [Vapi::ClientMessageUserInterrupted]
+    # @return [Vapi::ClientMessageMessage]
+    def self.user_interrupted(member:)
+      new(member: member, discriminant: "user-interrupted")
+    end
+
+    # @param member [Vapi::ClientMessageLanguageChanged]
+    # @return [Vapi::ClientMessageMessage]
+    def self.language_changed(member:)
+      new(member: member, discriminant: "language-changed")
+    end
+
+    # @param member [Vapi::ClientMessageVoiceInput]
+    # @return [Vapi::ClientMessageMessage]
+    def self.voice_input(member:)
+      new(member: member, discriminant: "voice-input")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/client_message_metadata.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class ClientMessageMetadata
+    # @return [String] This is the metadata content
+    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 metadata [String] This is the metadata content
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ClientMessageMetadata]
+    def initialize(metadata:, additional_properties: nil)
+      @metadata = metadata
+      @additional_properties = additional_properties
+      @_field_set = { "metadata": metadata }
+    end
+
+    # Deserialize a JSON object to an instance of ClientMessageMetadata
+    #
+    # @param json_object [String]
+    # @return [Vapi::ClientMessageMetadata]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      metadata = parsed_json["metadata"]
+      new(metadata: metadata, additional_properties: struct)
+    end
+
+    # Serialize an instance of ClientMessageMetadata 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.metadata.is_a?(String) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/client_message_model_output.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class ClientMessageModelOutput
+    # @return [Hash{String => Object}] This is the output of the model. It can be a token or tool call.
+    attr_reader :output
+    # @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 output [Hash{String => Object}] This is the output of the model. It can be a token or tool call.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ClientMessageModelOutput]
+    def initialize(output:, additional_properties: nil)
+      @output = output
+      @additional_properties = additional_properties
+      @_field_set = { "output": output }
+    end
+
+    # Deserialize a JSON object to an instance of ClientMessageModelOutput
+    #
+    # @param json_object [String]
+    # @return [Vapi::ClientMessageModelOutput]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      output = parsed_json["output"]
+      new(output: output, additional_properties: struct)
+    end
+
+    # Serialize an instance of ClientMessageModelOutput 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.output.is_a?(Hash) != false || raise("Passed value for field obj.output is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/client_message_speech_update.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative "client_message_speech_update_status"
+require_relative "client_message_speech_update_role"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ClientMessageSpeechUpdate
+    # @return [Vapi::ClientMessageSpeechUpdateStatus] This is the status of the speech update.
+    attr_reader :status
+    # @return [Vapi::ClientMessageSpeechUpdateRole] This is the role which the speech update is for.
+    attr_reader :role
+    # @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 status [Vapi::ClientMessageSpeechUpdateStatus] This is the status of the speech update.
+    # @param role [Vapi::ClientMessageSpeechUpdateRole] This is the role which the speech update is for.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ClientMessageSpeechUpdate]
+    def initialize(status:, role:, additional_properties: nil)
+      @status = status
+      @role = role
+      @additional_properties = additional_properties
+      @_field_set = { "status": status, "role": role }
+    end
+
+    # Deserialize a JSON object to an instance of ClientMessageSpeechUpdate
+    #
+    # @param json_object [String]
+    # @return [Vapi::ClientMessageSpeechUpdate]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      status = parsed_json["status"]
+      role = parsed_json["role"]
+      new(
+        status: status,
+        role: role,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ClientMessageSpeechUpdate 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.status.is_a?(Vapi::ClientMessageSpeechUpdateStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      obj.role.is_a?(Vapi::ClientMessageSpeechUpdateRole) != false || raise("Passed value for field obj.role is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/client_message_speech_update_role.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the role which the speech update is for.
+  class ClientMessageSpeechUpdateRole
+    ASSISTANT = "assistant"
+    USER = "user"
+  end
+end

data/lib/vapi_server_sdk/types/client_message_speech_update_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the status of the speech update.
+  class ClientMessageSpeechUpdateStatus
+    STARTED = "started"
+    STOPPED = "stopped"
+  end
+end

data/lib/vapi_server_sdk/types/client_message_tool_calls.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "client_message_tool_calls_tool_with_tool_call_list_item"
+require_relative "tool_call"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ClientMessageToolCalls
+    # @return [Array<Vapi::ClientMessageToolCallsToolWithToolCallListItem>] 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
+    # @return [Array<Vapi::ToolCall>] This is the list of tool calls that the model is requesting.
+    attr_reader :tool_call_list
+    # @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 tool_with_tool_call_list [Array<Vapi::ClientMessageToolCallsToolWithToolCallListItem>] This is the list of tools calls that the model is requesting along with the
+    #  original tool configuration.
+    # @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::ClientMessageToolCalls]
+    def initialize(tool_with_tool_call_list:, tool_call_list:, additional_properties: nil)
+      @tool_with_tool_call_list = tool_with_tool_call_list
+      @tool_call_list = tool_call_list
+      @additional_properties = additional_properties
+      @_field_set = { "toolWithToolCallList": tool_with_tool_call_list, "toolCallList": tool_call_list }
+    end
+
+    # Deserialize a JSON object to an instance of ClientMessageToolCalls
+    #
+    # @param json_object [String]
+    # @return [Vapi::ClientMessageToolCalls]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      tool_with_tool_call_list = parsed_json["toolWithToolCallList"]&.map do |item|
+        item = item.to_json
+        Vapi::ClientMessageToolCallsToolWithToolCallListItem.from_json(json_object: item)
+      end
+      tool_call_list = parsed_json["toolCallList"]&.map do |item|
+        item = item.to_json
+        Vapi::ToolCall.from_json(json_object: item)
+      end
+      new(
+        tool_with_tool_call_list: tool_with_tool_call_list,
+        tool_call_list: tool_call_list,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ClientMessageToolCalls 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.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.tool_call_list.is_a?(Array) != false || raise("Passed value for field obj.tool_call_list is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/client_message_tool_calls_result.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class ClientMessageToolCallsResult
+    # @return [Hash{String => Object}] This is the result of the tool call.
+    attr_reader :tool_call_result
+    # @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 tool_call_result [Hash{String => Object}] This is the result of the tool call.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ClientMessageToolCallsResult]
+    def initialize(tool_call_result:, additional_properties: nil)
+      @tool_call_result = tool_call_result
+      @additional_properties = additional_properties
+      @_field_set = { "toolCallResult": tool_call_result }
+    end
+
+    # Deserialize a JSON object to an instance of ClientMessageToolCallsResult
+    #
+    # @param json_object [String]
+    # @return [Vapi::ClientMessageToolCallsResult]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      tool_call_result = parsed_json["toolCallResult"]
+      new(tool_call_result: tool_call_result, additional_properties: struct)
+    end
+
+    # Serialize an instance of ClientMessageToolCallsResult 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.tool_call_result.is_a?(Hash) != false || raise("Passed value for field obj.tool_call_result is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/client_message_tool_calls_tool_with_tool_call_list_item.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "function_tool_with_tool_call"
+require_relative "ghl_tool_with_tool_call"
+require_relative "make_tool_with_tool_call"
+
+module Vapi
+  class ClientMessageToolCallsToolWithToolCallListItem
+    # @return [Object]
+    attr_reader :member
+    # @return [String]
+    attr_reader :discriminant
+
+    private_class_method :new
+    alias kind_of? is_a?
+
+    # @param member [Object]
+    # @param discriminant [String]
+    # @return [Vapi::ClientMessageToolCallsToolWithToolCallListItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  ClientMessageToolCallsToolWithToolCallListItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::ClientMessageToolCallsToolWithToolCallListItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "function"
+                 Vapi::FunctionToolWithToolCall.from_json(json_object: json_object)
+               when "ghl"
+                 Vapi::GhlToolWithToolCall.from_json(json_object: json_object)
+               when "make"
+                 Vapi::MakeToolWithToolCall.from_json(json_object: json_object)
+               else
+                 Vapi::FunctionToolWithToolCall.from_json(json_object: json_object)
+               end
+      new(member: member, discriminant: struct.type)
+    end
+
+    # For Union Types, to_json functionality is delegated to the wrapped member.
+    #
+    # @return [String]
+    def to_json(*_args)
+      case @discriminant
+      when "function"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "ghl"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "make"
+        { **@member.to_json, type: @discriminant }.to_json
+      else
+        { "type": @discriminant, value: @member }.to_json
+      end
+      @member.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:)
+      case obj.type
+      when "function"
+        Vapi::FunctionToolWithToolCall.validate_raw(obj: obj)
+      when "ghl"
+        Vapi::GhlToolWithToolCall.validate_raw(obj: obj)
+      when "make"
+        Vapi::MakeToolWithToolCall.validate_raw(obj: obj)
+      else
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+
+    # For Union Types, is_a? functionality is delegated to the wrapped member.
+    #
+    # @param obj [Object]
+    # @return [Boolean]
+    def is_a?(obj)
+      @member.is_a?(obj)
+    end
+
+    # @param member [Vapi::FunctionToolWithToolCall]
+    # @return [Vapi::ClientMessageToolCallsToolWithToolCallListItem]
+    def self.function(member:)
+      new(member: member, discriminant: "function")
+    end
+
+    # @param member [Vapi::GhlToolWithToolCall]
+    # @return [Vapi::ClientMessageToolCallsToolWithToolCallListItem]
+    def self.ghl(member:)
+      new(member: member, discriminant: "ghl")
+    end
+
+    # @param member [Vapi::MakeToolWithToolCall]
+    # @return [Vapi::ClientMessageToolCallsToolWithToolCallListItem]
+    def self.make(member:)
+      new(member: member, discriminant: "make")
+    end
+  end
+end