vapi_server_sdk 0.1.0 → 0.3.0

data/lib/vapi_server_sdk/types/update_tool_call_block_dto.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require_relative "update_tool_call_block_dto_messages_item"
+require_relative "json_schema"
+require_relative "update_tool_call_block_dto_tool"
+require "ostruct"
+require "json"
+
+module Vapi
+  class UpdateToolCallBlockDto
+    # @return [Array<Vapi::UpdateToolCallBlockDtoMessagesItem>] These are the pre-configured messages that will be spoken to the user while the
+    #  block is running.
+    attr_reader :messages
+    # @return [Vapi::JsonSchema] This is the input schema for the block. This is the input the block needs to
+    #  run. It's given to the block as `steps[0].input`
+    #  These are accessible as variables:
+    #  - ({{input.propertyName}}) in context of the block execution (step)
+    #  - ({{stepName.input.propertyName}}) in context of the workflow
+    attr_reader :input_schema
+    # @return [Vapi::JsonSchema] This is the output schema for the block. This is the output the block will
+    #  return to the workflow (`{{stepName.output}}`).
+    #  These are accessible as variables:
+    #  - ({{output.propertyName}}) in context of the block execution (step)
+    #  - ({{stepName.output.propertyName}}) in context of the workflow (read caveat #1)
+    #  - ({{blockName.output.propertyName}}) in context of the workflow (read caveat
+    #  #2)
+    #  Caveats:
+    #  1. a workflow can execute a step multiple times. example, if a loop is used in
+    #  the graph. {{stepName.output.propertyName}} will reference the latest usage of
+    #  the step.
+    #  2. a workflow can execute a block multiple times. example, if a step is called
+    #  multiple times or if a block is used in multiple steps.
+    #  {{blockName.output.propertyName}} will reference the latest usage of the block.
+    #  this liquid variable is just provided for convenience when creating blocks
+    #  outside of a workflow with steps.
+    attr_reader :output_schema
+    # @return [Vapi::UpdateToolCallBlockDtoTool] This is the tool that the block will call. To use an existing tool, use
+    #  `toolId`.
+    attr_reader :tool
+    # @return [String] This is the name of the block. This is just for your reference.
+    attr_reader :name
+    # @return [String] This is the id of the tool that the block will call. To use a transient tool,
+    #  use `tool`.
+    attr_reader :tool_id
+    # @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::UpdateToolCallBlockDtoMessagesItem>] These are the pre-configured messages that will be spoken to the user while the
+    #  block is running.
+    # @param input_schema [Vapi::JsonSchema] This is the input schema for the block. This is the input the block needs to
+    #  run. It's given to the block as `steps[0].input`
+    #  These are accessible as variables:
+    #  - ({{input.propertyName}}) in context of the block execution (step)
+    #  - ({{stepName.input.propertyName}}) in context of the workflow
+    # @param output_schema [Vapi::JsonSchema] This is the output schema for the block. This is the output the block will
+    #  return to the workflow (`{{stepName.output}}`).
+    #  These are accessible as variables:
+    #  - ({{output.propertyName}}) in context of the block execution (step)
+    #  - ({{stepName.output.propertyName}}) in context of the workflow (read caveat #1)
+    #  - ({{blockName.output.propertyName}}) in context of the workflow (read caveat
+    #  #2)
+    #  Caveats:
+    #  1. a workflow can execute a step multiple times. example, if a loop is used in
+    #  the graph. {{stepName.output.propertyName}} will reference the latest usage of
+    #  the step.
+    #  2. a workflow can execute a block multiple times. example, if a step is called
+    #  multiple times or if a block is used in multiple steps.
+    #  {{blockName.output.propertyName}} will reference the latest usage of the block.
+    #  this liquid variable is just provided for convenience when creating blocks
+    #  outside of a workflow with steps.
+    # @param tool [Vapi::UpdateToolCallBlockDtoTool] This is the tool that the block will call. To use an existing tool, use
+    #  `toolId`.
+    # @param name [String] This is the name of the block. This is just for your reference.
+    # @param tool_id [String] This is the id of the tool that the block will call. To use a transient tool,
+    #  use `tool`.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::UpdateToolCallBlockDto]
+    def initialize(messages: OMIT, input_schema: OMIT, output_schema: OMIT, tool: OMIT, name: OMIT, tool_id: OMIT,
+                   additional_properties: nil)
+      @messages = messages if messages != OMIT
+      @input_schema = input_schema if input_schema != OMIT
+      @output_schema = output_schema if output_schema != OMIT
+      @tool = tool if tool != OMIT
+      @name = name if name != OMIT
+      @tool_id = tool_id if tool_id != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "messages": messages,
+        "inputSchema": input_schema,
+        "outputSchema": output_schema,
+        "tool": tool,
+        "name": name,
+        "toolId": tool_id
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of UpdateToolCallBlockDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::UpdateToolCallBlockDto]
+    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::UpdateToolCallBlockDtoMessagesItem.from_json(json_object: item)
+      end
+      if parsed_json["inputSchema"].nil?
+        input_schema = nil
+      else
+        input_schema = parsed_json["inputSchema"].to_json
+        input_schema = Vapi::JsonSchema.from_json(json_object: input_schema)
+      end
+      if parsed_json["outputSchema"].nil?
+        output_schema = nil
+      else
+        output_schema = parsed_json["outputSchema"].to_json
+        output_schema = Vapi::JsonSchema.from_json(json_object: output_schema)
+      end
+      if parsed_json["tool"].nil?
+        tool = nil
+      else
+        tool = parsed_json["tool"].to_json
+        tool = Vapi::UpdateToolCallBlockDtoTool.from_json(json_object: tool)
+      end
+      name = parsed_json["name"]
+      tool_id = parsed_json["toolId"]
+      new(
+        messages: messages,
+        input_schema: input_schema,
+        output_schema: output_schema,
+        tool: tool,
+        name: name,
+        tool_id: tool_id,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of UpdateToolCallBlockDto 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.input_schema.nil? || Vapi::JsonSchema.validate_raw(obj: obj.input_schema)
+      obj.output_schema.nil? || Vapi::JsonSchema.validate_raw(obj: obj.output_schema)
+      obj.tool.nil? || Vapi::UpdateToolCallBlockDtoTool.validate_raw(obj: obj.tool)
+      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.tool_id&.is_a?(String) != false || raise("Passed value for field obj.tool_id is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/update_tool_call_block_dto_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 UpdateToolCallBlockDtoMessagesItem
+    # @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::UpdateToolCallBlockDtoMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of UpdateToolCallBlockDtoMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::UpdateToolCallBlockDtoMessagesItem]
+    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::UpdateToolCallBlockDtoMessagesItem]
+    def self.block_start(member:)
+      new(member: member, discriminant: "block-start")
+    end
+
+    # @param member [Vapi::BlockCompleteMessage]
+    # @return [Vapi::UpdateToolCallBlockDtoMessagesItem]
+    def self.block_complete(member:)
+      new(member: member, discriminant: "block-complete")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/update_tool_call_block_dto_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 UpdateToolCallBlockDtoTool
+    # @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::UpdateToolCallBlockDtoTool]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of UpdateToolCallBlockDtoTool
+    #
+    # @param json_object [String]
+    # @return [Vapi::UpdateToolCallBlockDtoTool]
+    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::UpdateToolCallBlockDtoTool]
+    def self.dtmf(member:)
+      new(member: member, discriminant: "dtmf")
+    end
+
+    # @param member [Vapi::CreateEndCallToolDto]
+    # @return [Vapi::UpdateToolCallBlockDtoTool]
+    def self.end_call(member:)
+      new(member: member, discriminant: "endCall")
+    end
+
+    # @param member [Vapi::CreateVoicemailToolDto]
+    # @return [Vapi::UpdateToolCallBlockDtoTool]
+    def self.voicemail(member:)
+      new(member: member, discriminant: "voicemail")
+    end
+
+    # @param member [Vapi::CreateFunctionToolDto]
+    # @return [Vapi::UpdateToolCallBlockDtoTool]
+    def self.function(member:)
+      new(member: member, discriminant: "function")
+    end
+
+    # @param member [Vapi::CreateGhlToolDto]
+    # @return [Vapi::UpdateToolCallBlockDtoTool]
+    def self.ghl(member:)
+      new(member: member, discriminant: "ghl")
+    end
+
+    # @param member [Vapi::CreateMakeToolDto]
+    # @return [Vapi::UpdateToolCallBlockDtoTool]
+    def self.make(member:)
+      new(member: member, discriminant: "make")
+    end
+
+    # @param member [Vapi::CreateTransferCallToolDto]
+    # @return [Vapi::UpdateToolCallBlockDtoTool]
+    def self.transfer_call(member:)
+      new(member: member, discriminant: "transferCall")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/update_transfer_call_tool_dto.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require_relative "update_transfer_call_tool_dto_messages_item"
+require_relative "update_transfer_call_tool_dto_destinations_item"
+require_relative "open_ai_function"
+require_relative "server"
+require "ostruct"
+require "json"
+
+module Vapi
+  class UpdateTransferCallToolDto
+    # @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::UpdateTransferCallToolDtoMessagesItem>] 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.
+    attr_reader :messages
+    # @return [Array<Vapi::UpdateTransferCallToolDtoDestinationsItem>] These are the destinations that the call can be transferred to. If no
+    #  destinations are provided, server.url will be used to get the transfer
+    #  destination once the tool is called.
+    attr_reader :destinations
+    # @return [Vapi::OpenAiFunction] This is the function definition of the tool.
+    #  For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on
+    #  tool-specific fields like `tool.destinations`. But, even in those cases, you can
+    #  provide a custom function definition for advanced use cases.
+    #  An example of an advanced use case is if you want to customize the message
+    #  that's spoken for `endCall` tool. You can specify a function where it returns an
+    #  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.
+    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]
+    attr_reader :_field_set
+    protected :_field_set
+
+    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::UpdateTransferCallToolDtoMessagesItem>] 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 destinations [Array<Vapi::UpdateTransferCallToolDtoDestinationsItem>] These are the destinations that the call can be transferred to. If no
+    #  destinations are provided, server.url will be used to get the transfer
+    #  destination once the tool is called.
+    # @param function [Vapi::OpenAiFunction] This is the function definition of the tool.
+    #  For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on
+    #  tool-specific fields like `tool.destinations`. But, even in those cases, you can
+    #  provide a custom function definition for advanced use cases.
+    #  An example of an advanced use case is if you want to customize the message
+    #  that's spoken for `endCall` tool. You can specify a function where it returns an
+    #  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::UpdateTransferCallToolDto]
+    def initialize(async: OMIT, messages: OMIT, destinations: OMIT, function: OMIT, server: OMIT,
+                   additional_properties: nil)
+      @async = async if async != OMIT
+      @messages = messages if messages != OMIT
+      @destinations = destinations if destinations != OMIT
+      @function = function if function != OMIT
+      @server = server if server != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "async": async,
+        "messages": messages,
+        "destinations": destinations,
+        "function": function,
+        "server": server
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of UpdateTransferCallToolDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::UpdateTransferCallToolDto]
+    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::UpdateTransferCallToolDtoMessagesItem.from_json(json_object: item)
+      end
+      destinations = parsed_json["destinations"]&.map do |item|
+        item = item.to_json
+        Vapi::UpdateTransferCallToolDtoDestinationsItem.from_json(json_object: item)
+      end
+      if parsed_json["function"].nil?
+        function = nil
+      else
+        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,
+        destinations: destinations,
+        function: function,
+        server: server,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of UpdateTransferCallToolDto 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.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.destinations&.is_a?(Array) != false || raise("Passed value for field obj.destinations 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