vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/tool_call_block_messages_item.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "block_start_message"
+require_relative "block_complete_message"
+
+module Vapi
+  class ToolCallBlockMessagesItem
+    # @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::ToolCallBlockMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of ToolCallBlockMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::ToolCallBlockMessagesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "block-start"
+                 Vapi::BlockStartMessage.from_json(json_object: json_object)
+               when "block-complete"
+                 Vapi::BlockCompleteMessage.from_json(json_object: json_object)
+               else
+                 Vapi::BlockStartMessage.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 "block-start"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "block-complete"
+        { **@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 "block-start"
+        Vapi::BlockStartMessage.validate_raw(obj: obj)
+      when "block-complete"
+        Vapi::BlockCompleteMessage.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::BlockStartMessage]
+    # @return [Vapi::ToolCallBlockMessagesItem]
+    def self.block_start(member:)
+      new(member: member, discriminant: "block-start")
+    end
+
+    # @param member [Vapi::BlockCompleteMessage]
+    # @return [Vapi::ToolCallBlockMessagesItem]
+    def self.block_complete(member:)
+      new(member: member, discriminant: "block-complete")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/tool_call_block_tool.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "create_dtmf_tool_dto"
+require_relative "create_end_call_tool_dto"
+require_relative "create_voicemail_tool_dto"
+require_relative "create_function_tool_dto"
+require_relative "create_ghl_tool_dto"
+require_relative "create_make_tool_dto"
+require_relative "create_transfer_call_tool_dto"
+
+module Vapi
+  # This is the tool that the block will call. To use an existing tool, use
+  #  `toolId`.
+  class ToolCallBlockTool
+    # @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::ToolCallBlockTool]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of ToolCallBlockTool
+    #
+    # @param json_object [String]
+    # @return [Vapi::ToolCallBlockTool]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "dtmf"
+                 Vapi::CreateDtmfToolDto.from_json(json_object: json_object)
+               when "endCall"
+                 Vapi::CreateEndCallToolDto.from_json(json_object: json_object)
+               when "voicemail"
+                 Vapi::CreateVoicemailToolDto.from_json(json_object: json_object)
+               when "function"
+                 Vapi::CreateFunctionToolDto.from_json(json_object: json_object)
+               when "ghl"
+                 Vapi::CreateGhlToolDto.from_json(json_object: json_object)
+               when "make"
+                 Vapi::CreateMakeToolDto.from_json(json_object: json_object)
+               when "transferCall"
+                 Vapi::CreateTransferCallToolDto.from_json(json_object: json_object)
+               else
+                 Vapi::CreateDtmfToolDto.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 "dtmf"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "endCall"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "voicemail"
+        { **@member.to_json, type: @discriminant }.to_json
+      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
+      when "transferCall"
+        { **@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 "dtmf"
+        Vapi::CreateDtmfToolDto.validate_raw(obj: obj)
+      when "endCall"
+        Vapi::CreateEndCallToolDto.validate_raw(obj: obj)
+      when "voicemail"
+        Vapi::CreateVoicemailToolDto.validate_raw(obj: obj)
+      when "function"
+        Vapi::CreateFunctionToolDto.validate_raw(obj: obj)
+      when "ghl"
+        Vapi::CreateGhlToolDto.validate_raw(obj: obj)
+      when "make"
+        Vapi::CreateMakeToolDto.validate_raw(obj: obj)
+      when "transferCall"
+        Vapi::CreateTransferCallToolDto.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::CreateDtmfToolDto]
+    # @return [Vapi::ToolCallBlockTool]
+    def self.dtmf(member:)
+      new(member: member, discriminant: "dtmf")
+    end
+
+    # @param member [Vapi::CreateEndCallToolDto]
+    # @return [Vapi::ToolCallBlockTool]
+    def self.end_call(member:)
+      new(member: member, discriminant: "endCall")
+    end
+
+    # @param member [Vapi::CreateVoicemailToolDto]
+    # @return [Vapi::ToolCallBlockTool]
+    def self.voicemail(member:)
+      new(member: member, discriminant: "voicemail")
+    end
+
+    # @param member [Vapi::CreateFunctionToolDto]
+    # @return [Vapi::ToolCallBlockTool]
+    def self.function(member:)
+      new(member: member, discriminant: "function")
+    end
+
+    # @param member [Vapi::CreateGhlToolDto]
+    # @return [Vapi::ToolCallBlockTool]
+    def self.ghl(member:)
+      new(member: member, discriminant: "ghl")
+    end
+
+    # @param member [Vapi::CreateMakeToolDto]
+    # @return [Vapi::ToolCallBlockTool]
+    def self.make(member:)
+      new(member: member, discriminant: "make")
+    end
+
+    # @param member [Vapi::CreateTransferCallToolDto]
+    # @return [Vapi::ToolCallBlockTool]
+    def self.transfer_call(member:)
+      new(member: member, discriminant: "transferCall")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/tool_call_function.rb

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

data/lib/vapi_server_sdk/types/tool_call_message.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class ToolCallMessage
+    # @return [String] The role of the tool call in the conversation.
+    attr_reader :role
+    # @return [Array<Hash{String => Object}>] The list of tool calls made during the conversation.
+    attr_reader :tool_calls
+    # @return [String] The message content for the tool call.
+    attr_reader :message
+    # @return [Float] The timestamp when the message was sent.
+    attr_reader :time
+    # @return [Float] The number of seconds from the start of the conversation.
+    attr_reader :seconds_from_start
+    # @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 [String] The role of the tool call in the conversation.
+    # @param tool_calls [Array<Hash{String => Object}>] The list of tool calls made during the conversation.
+    # @param message [String] The message content for the tool call.
+    # @param time [Float] The timestamp when the message was sent.
+    # @param seconds_from_start [Float] The number of seconds from the start of the conversation.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ToolCallMessage]
+    def initialize(role:, tool_calls:, message:, time:, seconds_from_start:, additional_properties: nil)
+      @role = role
+      @tool_calls = tool_calls
+      @message = message
+      @time = time
+      @seconds_from_start = seconds_from_start
+      @additional_properties = additional_properties
+      @_field_set = {
+        "role": role,
+        "toolCalls": tool_calls,
+        "message": message,
+        "time": time,
+        "secondsFromStart": seconds_from_start
+      }
+    end
+
+    # Deserialize a JSON object to an instance of ToolCallMessage
+    #
+    # @param json_object [String]
+    # @return [Vapi::ToolCallMessage]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      role = parsed_json["role"]
+      tool_calls = parsed_json["toolCalls"]
+      message = parsed_json["message"]
+      time = parsed_json["time"]
+      seconds_from_start = parsed_json["secondsFromStart"]
+      new(
+        role: role,
+        tool_calls: tool_calls,
+        message: message,
+        time: time,
+        seconds_from_start: seconds_from_start,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ToolCallMessage 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?(String) != false || raise("Passed value for field obj.role is not the expected type, validation failed.")
+      obj.tool_calls.is_a?(Array) != false || raise("Passed value for field obj.tool_calls is not the expected type, validation failed.")
+      obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+      obj.time.is_a?(Float) != false || raise("Passed value for field obj.time is not the expected type, validation failed.")
+      obj.seconds_from_start.is_a?(Float) != false || raise("Passed value for field obj.seconds_from_start is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/tool_call_result.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require_relative "tool_call_result_message_item"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ToolCallResult
+    # @return [Array<Vapi::ToolCallResultMessageItem>] This is the message that will be spoken to the user.
+    #  If this is not returned, assistant will speak:
+    #  1. a `request-complete` or `request-failed` message from `tool.messages`, if it
+    #  exists
+    #  2. a response generated by the model, if not
+    attr_reader :message
+    # @return [String] This is the name of the function the model called.
+    attr_reader :name
+    # @return [String] This is the unique identifier for the tool call.
+    attr_reader :tool_call_id
+    # @return [String] This is the result if the tool call was successful. This is added to the
+    #  conversation history.
+    #  Further, if this is returned, assistant will speak:
+    #  1. the `message`, if it exists and is of type `request-complete`
+    #  2. a `request-complete` message from `tool.messages`, if it exists
+    #  3. a response generated by the model, if neither exist
+    attr_reader :result
+    # @return [String] This is the error if the tool call was not successful. This is added to the
+    #  conversation history.
+    #  Further, if this is returned, assistant will speak:
+    #  1. the `message`, if it exists and is of type `request-failed`
+    #  2. a `request-failed` message from `tool.messages`, if it exists
+    #  3. a response generated by the model, if neither exist
+    attr_reader :error
+    # @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 message [Array<Vapi::ToolCallResultMessageItem>] This is the message that will be spoken to the user.
+    #  If this is not returned, assistant will speak:
+    #  1. a `request-complete` or `request-failed` message from `tool.messages`, if it
+    #  exists
+    #  2. a response generated by the model, if not
+    # @param name [String] This is the name of the function the model called.
+    # @param tool_call_id [String] This is the unique identifier for the tool call.
+    # @param result [String] This is the result if the tool call was successful. This is added to the
+    #  conversation history.
+    #  Further, if this is returned, assistant will speak:
+    #  1. the `message`, if it exists and is of type `request-complete`
+    #  2. a `request-complete` message from `tool.messages`, if it exists
+    #  3. a response generated by the model, if neither exist
+    # @param error [String] This is the error if the tool call was not successful. This is added to the
+    #  conversation history.
+    #  Further, if this is returned, assistant will speak:
+    #  1. the `message`, if it exists and is of type `request-failed`
+    #  2. a `request-failed` message from `tool.messages`, if it exists
+    #  3. a response generated by the model, if neither exist
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ToolCallResult]
+    def initialize(name:, tool_call_id:, message: OMIT, result: OMIT, error: OMIT, additional_properties: nil)
+      @message = message if message != OMIT
+      @name = name
+      @tool_call_id = tool_call_id
+      @result = result if result != OMIT
+      @error = error if error != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "message": message,
+        "name": name,
+        "toolCallId": tool_call_id,
+        "result": result,
+        "error": error
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ToolCallResult
+    #
+    # @param json_object [String]
+    # @return [Vapi::ToolCallResult]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      message = parsed_json["message"]&.map do |item|
+        item = item.to_json
+        Vapi::ToolCallResultMessageItem.from_json(json_object: item)
+      end
+      name = parsed_json["name"]
+      tool_call_id = parsed_json["toolCallId"]
+      result = parsed_json["result"]
+      error = parsed_json["error"]
+      new(
+        message: message,
+        name: name,
+        tool_call_id: tool_call_id,
+        result: result,
+        error: error,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ToolCallResult 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.message&.is_a?(Array) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.tool_call_id.is_a?(String) != false || raise("Passed value for field obj.tool_call_id is not the expected type, validation failed.")
+      obj.result&.is_a?(String) != false || raise("Passed value for field obj.result is not the expected type, validation failed.")
+      obj.error&.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/tool_call_result_message.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class ToolCallResultMessage
+    # @return [String] The role of the tool call result in the conversation.
+    attr_reader :role
+    # @return [String] The ID of the tool call.
+    attr_reader :tool_call_id
+    # @return [String] The name of the tool that returned the result.
+    attr_reader :name
+    # @return [String] The result of the tool call in JSON format.
+    attr_reader :result
+    # @return [Float] The timestamp when the message was sent.
+    attr_reader :time
+    # @return [Float] The number of seconds from the start of the conversation.
+    attr_reader :seconds_from_start
+    # @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 [String] The role of the tool call result in the conversation.
+    # @param tool_call_id [String] The ID of the tool call.
+    # @param name [String] The name of the tool that returned the result.
+    # @param result [String] The result of the tool call in JSON format.
+    # @param time [Float] The timestamp when the message was sent.
+    # @param seconds_from_start [Float] The number of seconds from the start of the conversation.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ToolCallResultMessage]
+    def initialize(role:, tool_call_id:, name:, result:, time:, seconds_from_start:, additional_properties: nil)
+      @role = role
+      @tool_call_id = tool_call_id
+      @name = name
+      @result = result
+      @time = time
+      @seconds_from_start = seconds_from_start
+      @additional_properties = additional_properties
+      @_field_set = {
+        "role": role,
+        "toolCallId": tool_call_id,
+        "name": name,
+        "result": result,
+        "time": time,
+        "secondsFromStart": seconds_from_start
+      }
+    end
+
+    # Deserialize a JSON object to an instance of ToolCallResultMessage
+    #
+    # @param json_object [String]
+    # @return [Vapi::ToolCallResultMessage]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      role = parsed_json["role"]
+      tool_call_id = parsed_json["toolCallId"]
+      name = parsed_json["name"]
+      result = parsed_json["result"]
+      time = parsed_json["time"]
+      seconds_from_start = parsed_json["secondsFromStart"]
+      new(
+        role: role,
+        tool_call_id: tool_call_id,
+        name: name,
+        result: result,
+        time: time,
+        seconds_from_start: seconds_from_start,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ToolCallResultMessage 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?(String) != false || raise("Passed value for field obj.role is not the expected type, validation failed.")
+      obj.tool_call_id.is_a?(String) != false || raise("Passed value for field obj.tool_call_id is not the expected type, validation failed.")
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.result.is_a?(String) != false || raise("Passed value for field obj.result is not the expected type, validation failed.")
+      obj.time.is_a?(Float) != false || raise("Passed value for field obj.time is not the expected type, validation failed.")
+      obj.seconds_from_start.is_a?(Float) != false || raise("Passed value for field obj.seconds_from_start is not the expected type, validation failed.")
+    end
+  end
+end