vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/computer_tool_with_tool_call.rb

@@ -1,21 +1,14 @@
 # frozen_string_literal: true
 
 require_relative "computer_tool_with_tool_call_messages_item"
+require_relative "server"
 require_relative "tool_call"
 require_relative "open_ai_function"
-require_relative "server"
 require "ostruct"
 require "json"
 
 module Vapi
   class ComputerToolWithToolCall
-    # @return [Boolean] This determines if the tool is async.
-    #  If async, the assistant will move forward without waiting for your server to
-    #  respond. This is useful if you just want to trigger something on your server.
-    #  If sync, the assistant will wait for your server to respond. This is useful if
-    #  want assistant to respond with the result from your server.
-    #  Defaults to synchronous (`false`).
-    attr_reader :async
     # @return [Array<Vapi::ComputerToolWithToolCallMessagesItem>] These are the messages that will be spoken to the user as the tool is running.
     #  For some tools, this is auto-filled based on special fields like
     #  `tool.destinations`. For others like the function tool, these can be custom
@@ -23,6 +16,17 @@ module Vapi
     attr_reader :messages
     # @return [String] The sub type of tool.
     attr_reader :sub_type
+    # @return [Vapi::Server]
+    #  This is the server where a `tool-calls` webhook will be sent.
+    #  Notes:
+    #  - Webhook is sent to this server when a tool call is made.
+    #  - Webhook contains the call, assistant, and phone number objects.
+    #  - Webhook contains the variables set on the assistant.
+    #  - Webhook is sent to the first available URL in this order:
+    #  {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}},
+    #  {{org.server.url}}.
+    #  - Webhook expects a response with tool call result.
+    attr_reader :server
     # @return [Vapi::ToolCall]
     attr_reader :tool_call
     # @return [String] The name of the tool, fixed to 'computer'
@@ -43,13 +47,6 @@ module Vapi
     #  "request-complete" messages. One of these messages will be triggered if the
     #  `messages[].conditions` matches the "reason" argument.
     attr_reader :function
-    # @return [Vapi::Server] This is the server that will be hit when this tool is requested by the model.
-    #  All requests will be sent with the call object among other things. You can find
-    #  more details in the Server URL documentation.
-    #  This overrides the serverUrl set on the org and the phoneNumber. Order of
-    #  precedence: highest tool.server.url, then assistant.serverUrl, then
-    #  phoneNumber.serverUrl, then org.serverUrl.
-    attr_reader :server
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -58,17 +55,21 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param async [Boolean] This determines if the tool is async.
-    #  If async, the assistant will move forward without waiting for your server to
-    #  respond. This is useful if you just want to trigger something on your server.
-    #  If sync, the assistant will wait for your server to respond. This is useful if
-    #  want assistant to respond with the result from your server.
-    #  Defaults to synchronous (`false`).
     # @param messages [Array<Vapi::ComputerToolWithToolCallMessagesItem>] These are the messages that will be spoken to the user as the tool is running.
     #  For some tools, this is auto-filled based on special fields like
     #  `tool.destinations`. For others like the function tool, these can be custom
     #  configured.
     # @param sub_type [String] The sub type of tool.
+    # @param server [Vapi::Server]
+    #  This is the server where a `tool-calls` webhook will be sent.
+    #  Notes:
+    #  - Webhook is sent to this server when a tool call is made.
+    #  - Webhook contains the call, assistant, and phone number objects.
+    #  - Webhook contains the variables set on the assistant.
+    #  - Webhook is sent to the first available URL in this order:
+    #  {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}},
+    #  {{org.server.url}}.
+    #  - Webhook expects a response with tool call result.
     # @param tool_call [Vapi::ToolCall]
     # @param name [String] The name of the tool, fixed to 'computer'
     # @param display_width_px [Float] The display width in pixels
@@ -83,38 +84,30 @@ module Vapi
     #  argument "reason". Then, in `messages` array, you can have many
     #  "request-complete" messages. One of these messages will be triggered if the
     #  `messages[].conditions` matches the "reason" argument.
-    # @param server [Vapi::Server] This is the server that will be hit when this tool is requested by the model.
-    #  All requests will be sent with the call object among other things. You can find
-    #  more details in the Server URL documentation.
-    #  This overrides the serverUrl set on the org and the phoneNumber. Order of
-    #  precedence: highest tool.server.url, then assistant.serverUrl, then
-    #  phoneNumber.serverUrl, then org.serverUrl.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ComputerToolWithToolCall]
-    def initialize(sub_type:, tool_call:, name:, display_width_px:, display_height_px:, async: OMIT, messages: OMIT,
-                   display_number: OMIT, function: OMIT, server: OMIT, additional_properties: nil)
-      @async = async if async != OMIT
+    def initialize(sub_type:, tool_call:, name:, display_width_px:, display_height_px:, messages: OMIT, server: OMIT,
+                   display_number: OMIT, function: OMIT, additional_properties: nil)
       @messages = messages if messages != OMIT
       @sub_type = sub_type
+      @server = server if server != OMIT
       @tool_call = tool_call
       @name = name
       @display_width_px = display_width_px
       @display_height_px = display_height_px
       @display_number = display_number if display_number != OMIT
       @function = function if function != OMIT
-      @server = server if server != OMIT
       @additional_properties = additional_properties
       @_field_set = {
-        "async": async,
         "messages": messages,
         "subType": sub_type,
+        "server": server,
         "toolCall": tool_call,
         "name": name,
         "displayWidthPx": display_width_px,
         "displayHeightPx": display_height_px,
         "displayNumber": display_number,
-        "function": function,
-        "server": server
+        "function": function
       }.reject do |_k, v|
         v == OMIT
       end
@@ -127,12 +120,17 @@ module Vapi
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      async = parsed_json["async"]
       messages = parsed_json["messages"]&.map do |item|
         item = item.to_json
         Vapi::ComputerToolWithToolCallMessagesItem.from_json(json_object: item)
       end
       sub_type = parsed_json["subType"]
+      if parsed_json["server"].nil?
+        server = nil
+      else
+        server = parsed_json["server"].to_json
+        server = Vapi::Server.from_json(json_object: server)
+      end
       if parsed_json["toolCall"].nil?
         tool_call = nil
       else
@@ -149,23 +147,16 @@ module Vapi
         function = parsed_json["function"].to_json
         function = Vapi::OpenAiFunction.from_json(json_object: function)
       end
-      if parsed_json["server"].nil?
-        server = nil
-      else
-        server = parsed_json["server"].to_json
-        server = Vapi::Server.from_json(json_object: server)
-      end
       new(
-        async: async,
         messages: messages,
         sub_type: sub_type,
+        server: server,
         tool_call: tool_call,
         name: name,
         display_width_px: display_width_px,
         display_height_px: display_height_px,
         display_number: display_number,
         function: function,
-        server: server,
         additional_properties: struct
       )
     end
@@ -184,16 +175,15 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.async&.is_a?(Boolean) != false || raise("Passed value for field obj.async 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.sub_type.is_a?(String) != false || raise("Passed value for field obj.sub_type is not the expected type, validation failed.")
+      obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
       Vapi::ToolCall.validate_raw(obj: obj.tool_call)
       obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
       obj.display_width_px.is_a?(Float) != false || raise("Passed value for field obj.display_width_px is not the expected type, validation failed.")
       obj.display_height_px.is_a?(Float) != false || raise("Passed value for field obj.display_height_px is not the expected type, validation failed.")
       obj.display_number&.is_a?(Float) != false || raise("Passed value for field obj.display_number is not the expected type, validation failed.")
       obj.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)
-      obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
     end
   end
 end

data/lib/vapi_server_sdk/types/condition.rb

@@ -10,7 +10,7 @@ module Vapi
     attr_reader :operator
     # @return [String] This is the name of the parameter that you want to check.
     attr_reader :param
-    # @return [Hash{String => Object}] This is the value you want to compare against the parameter.
+    # @return [String] This is the value you want to compare against the parameter.
     attr_reader :value
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
@@ -22,7 +22,7 @@ module Vapi
 
     # @param operator [Vapi::ConditionOperator] This is the operator you want to use to compare the parameter and value.
     # @param param [String] This is the name of the parameter that you want to check.
-    # @param value [Hash{String => Object}] This is the value you want to compare against the parameter.
+    # @param value [String] This is the value you want to compare against the parameter.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::Condition]
     def initialize(operator:, param:, value:, additional_properties: nil)
@@ -67,7 +67,7 @@ module Vapi
     def self.validate_raw(obj:)
       obj.operator.is_a?(Vapi::ConditionOperator) != false || raise("Passed value for field obj.operator is not the expected type, validation failed.")
       obj.param.is_a?(String) != false || raise("Passed value for field obj.param is not the expected type, validation failed.")
-      obj.value.is_a?(Hash) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+      obj.value.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/conversation_node.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+require_relative "conversation_node_model"
+require_relative "conversation_node_transcriber"
+require_relative "conversation_node_voice"
+require_relative "global_node_plan"
+require_relative "variable_extraction_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ConversationNode
+    # @return [Vapi::ConversationNodeModel] This is the model for the node.
+    #  This overrides `workflow.model`.
+    attr_reader :model
+    # @return [Vapi::ConversationNodeTranscriber] This is the transcriber for the node.
+    #  This overrides `workflow.transcriber`.
+    attr_reader :transcriber
+    # @return [Vapi::ConversationNodeVoice] This is the voice for the node.
+    #  This overrides `workflow.voice`.
+    attr_reader :voice
+    # @return [String]
+    attr_reader :prompt
+    # @return [Vapi::GlobalNodePlan] This is the plan for the global node.
+    attr_reader :global_node_plan
+    # @return [Vapi::VariableExtractionPlan] This is the plan that controls the variable extraction from the user's
+    #  responses.
+    #  Usage:
+    #  Use `schema` to specify what you want to extract from the user's responses.
+    #  ```json
+    #  {
+    #  "schema": {
+    #  "type": "object",
+    #  "properties": {
+    #  "user": {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "string"
+    #  },
+    #  "age": {
+    #  "type": "number"
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  This will be extracted as `{{ user.name }}` and `{{ user.age }}` respectively.
+    #  (Optional) Use `aliases` to create new variables.
+    #  ```json
+    #  {
+    #  "aliases": [
+    #  {
+    #  "key": "userAge",
+    #  "value": "{{user.age}}"
+    #  },
+    #  {
+    #  "key": "userName",
+    #  "value": "{{user.name}}"
+    #  }
+    #  ]
+    #  }
+    #  ```
+    #  This will be extracted as `{{ userAge }}` and `{{ userName }}` respectively.
+    #  Note: The `schema` field is required for Conversation nodes if you want to
+    #  extract variables from the user's responses. `aliases` is just a convenience.
+    attr_reader :variable_extraction_plan
+    # @return [String]
+    attr_reader :name
+    # @return [Boolean] This is whether or not the node is the start of the workflow.
+    attr_reader :is_start
+    # @return [Hash{String => Object}] This is for metadata you want to store on the task.
+    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 model [Vapi::ConversationNodeModel] This is the model for the node.
+    #  This overrides `workflow.model`.
+    # @param transcriber [Vapi::ConversationNodeTranscriber] This is the transcriber for the node.
+    #  This overrides `workflow.transcriber`.
+    # @param voice [Vapi::ConversationNodeVoice] This is the voice for the node.
+    #  This overrides `workflow.voice`.
+    # @param prompt [String]
+    # @param global_node_plan [Vapi::GlobalNodePlan] This is the plan for the global node.
+    # @param variable_extraction_plan [Vapi::VariableExtractionPlan] This is the plan that controls the variable extraction from the user's
+    #  responses.
+    #  Usage:
+    #  Use `schema` to specify what you want to extract from the user's responses.
+    #  ```json
+    #  {
+    #  "schema": {
+    #  "type": "object",
+    #  "properties": {
+    #  "user": {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "string"
+    #  },
+    #  "age": {
+    #  "type": "number"
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  This will be extracted as `{{ user.name }}` and `{{ user.age }}` respectively.
+    #  (Optional) Use `aliases` to create new variables.
+    #  ```json
+    #  {
+    #  "aliases": [
+    #  {
+    #  "key": "userAge",
+    #  "value": "{{user.age}}"
+    #  },
+    #  {
+    #  "key": "userName",
+    #  "value": "{{user.name}}"
+    #  }
+    #  ]
+    #  }
+    #  ```
+    #  This will be extracted as `{{ userAge }}` and `{{ userName }}` respectively.
+    #  Note: The `schema` field is required for Conversation nodes if you want to
+    #  extract variables from the user's responses. `aliases` is just a convenience.
+    # @param name [String]
+    # @param is_start [Boolean] This is whether or not the node is the start of the workflow.
+    # @param metadata [Hash{String => Object}] This is for metadata you want to store on the task.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ConversationNode]
+    def initialize(name:, model: OMIT, transcriber: OMIT, voice: OMIT, prompt: OMIT, global_node_plan: OMIT,
+                   variable_extraction_plan: OMIT, is_start: OMIT, metadata: OMIT, additional_properties: nil)
+      @model = model if model != OMIT
+      @transcriber = transcriber if transcriber != OMIT
+      @voice = voice if voice != OMIT
+      @prompt = prompt if prompt != OMIT
+      @global_node_plan = global_node_plan if global_node_plan != OMIT
+      @variable_extraction_plan = variable_extraction_plan if variable_extraction_plan != OMIT
+      @name = name
+      @is_start = is_start if is_start != OMIT
+      @metadata = metadata if metadata != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "model": model,
+        "transcriber": transcriber,
+        "voice": voice,
+        "prompt": prompt,
+        "globalNodePlan": global_node_plan,
+        "variableExtractionPlan": variable_extraction_plan,
+        "name": name,
+        "isStart": is_start,
+        "metadata": metadata
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ConversationNode
+    #
+    # @param json_object [String]
+    # @return [Vapi::ConversationNode]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["model"].nil?
+        model = nil
+      else
+        model = parsed_json["model"].to_json
+        model = Vapi::ConversationNodeModel.from_json(json_object: model)
+      end
+      if parsed_json["transcriber"].nil?
+        transcriber = nil
+      else
+        transcriber = parsed_json["transcriber"].to_json
+        transcriber = Vapi::ConversationNodeTranscriber.from_json(json_object: transcriber)
+      end
+      if parsed_json["voice"].nil?
+        voice = nil
+      else
+        voice = parsed_json["voice"].to_json
+        voice = Vapi::ConversationNodeVoice.from_json(json_object: voice)
+      end
+      prompt = parsed_json["prompt"]
+      if parsed_json["globalNodePlan"].nil?
+        global_node_plan = nil
+      else
+        global_node_plan = parsed_json["globalNodePlan"].to_json
+        global_node_plan = Vapi::GlobalNodePlan.from_json(json_object: global_node_plan)
+      end
+      if parsed_json["variableExtractionPlan"].nil?
+        variable_extraction_plan = nil
+      else
+        variable_extraction_plan = parsed_json["variableExtractionPlan"].to_json
+        variable_extraction_plan = Vapi::VariableExtractionPlan.from_json(json_object: variable_extraction_plan)
+      end
+      name = parsed_json["name"]
+      is_start = parsed_json["isStart"]
+      metadata = parsed_json["metadata"]
+      new(
+        model: model,
+        transcriber: transcriber,
+        voice: voice,
+        prompt: prompt,
+        global_node_plan: global_node_plan,
+        variable_extraction_plan: variable_extraction_plan,
+        name: name,
+        is_start: is_start,
+        metadata: metadata,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ConversationNode 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.model.nil? || Vapi::ConversationNodeModel.validate_raw(obj: obj.model)
+      obj.transcriber.nil? || Vapi::ConversationNodeTranscriber.validate_raw(obj: obj.transcriber)
+      obj.voice.nil? || Vapi::ConversationNodeVoice.validate_raw(obj: obj.voice)
+      obj.prompt&.is_a?(String) != false || raise("Passed value for field obj.prompt is not the expected type, validation failed.")
+      obj.global_node_plan.nil? || Vapi::GlobalNodePlan.validate_raw(obj: obj.global_node_plan)
+      obj.variable_extraction_plan.nil? || Vapi::VariableExtractionPlan.validate_raw(obj: obj.variable_extraction_plan)
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.is_start&.is_a?(Boolean) != false || raise("Passed value for field obj.is_start is not the expected type, validation failed.")
+      obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/conversation_node_model.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "workflow_open_ai_model"
+require_relative "workflow_anthropic_model"
+require_relative "workflow_google_model"
+require_relative "workflow_custom_model"
+
+module Vapi
+  # This is the model for the node.
+  #  This overrides `workflow.model`.
+  class ConversationNodeModel
+    # @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::ConversationNodeModel]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of ConversationNodeModel
+    #
+    # @param json_object [String]
+    # @return [Vapi::ConversationNodeModel]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.provider
+               when "openai"
+                 Vapi::WorkflowOpenAiModel.from_json(json_object: json_object)
+               when "anthropic"
+                 Vapi::WorkflowAnthropicModel.from_json(json_object: json_object)
+               when "google"
+                 Vapi::WorkflowGoogleModel.from_json(json_object: json_object)
+               when "custom-llm"
+                 Vapi::WorkflowCustomModel.from_json(json_object: json_object)
+               else
+                 Vapi::WorkflowOpenAiModel.from_json(json_object: json_object)
+               end
+      new(member: member, discriminant: struct.provider)
+    end
+
+    # For Union Types, to_json functionality is delegated to the wrapped member.
+    #
+    # @return [String]
+    def to_json(*_args)
+      case @discriminant
+      when "openai"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "anthropic"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "google"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "custom-llm"
+        { **@member.to_json, provider: @discriminant }.to_json
+      else
+        { "provider": @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.provider
+      when "openai"
+        Vapi::WorkflowOpenAiModel.validate_raw(obj: obj)
+      when "anthropic"
+        Vapi::WorkflowAnthropicModel.validate_raw(obj: obj)
+      when "google"
+        Vapi::WorkflowGoogleModel.validate_raw(obj: obj)
+      when "custom-llm"
+        Vapi::WorkflowCustomModel.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::WorkflowOpenAiModel]
+    # @return [Vapi::ConversationNodeModel]
+    def self.openai(member:)
+      new(member: member, discriminant: "openai")
+    end
+
+    # @param member [Vapi::WorkflowAnthropicModel]
+    # @return [Vapi::ConversationNodeModel]
+    def self.anthropic(member:)
+      new(member: member, discriminant: "anthropic")
+    end
+
+    # @param member [Vapi::WorkflowGoogleModel]
+    # @return [Vapi::ConversationNodeModel]
+    def self.google(member:)
+      new(member: member, discriminant: "google")
+    end
+
+    # @param member [Vapi::WorkflowCustomModel]
+    # @return [Vapi::ConversationNodeModel]
+    def self.custom_llm(member:)
+      new(member: member, discriminant: "custom-llm")
+    end
+  end
+end