vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/create_dtmf_tool_dto.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require_relative "create_dtmf_tool_dto_messages_item"
+require_relative "open_ai_function"
+require_relative "server"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateDtmfToolDto
+    # @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::CreateDtmfToolDtoMessagesItem>] 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 [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::CreateDtmfToolDtoMessagesItem>] 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 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::CreateDtmfToolDto]
+    def initialize(async: OMIT, messages: OMIT, function: OMIT, server: OMIT, additional_properties: nil)
+      @async = async if async != OMIT
+      @messages = messages if messages != OMIT
+      @function = function if function != OMIT
+      @server = server if server != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "async": async, "messages": messages, "function": function, "server": server }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateDtmfToolDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateDtmfToolDto]
+    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::CreateDtmfToolDtoMessagesItem.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,
+        function: function,
+        server: server,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateDtmfToolDto 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.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/create_dtmf_tool_dto_messages_item.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "tool_message_start"
+require_relative "tool_message_complete"
+require_relative "tool_message_failed"
+require_relative "tool_message_delayed"
+
+module Vapi
+  class CreateDtmfToolDtoMessagesItem
+    # @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::CreateDtmfToolDtoMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of CreateDtmfToolDtoMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateDtmfToolDtoMessagesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "request-start"
+                 Vapi::ToolMessageStart.from_json(json_object: json_object)
+               when "request-complete"
+                 Vapi::ToolMessageComplete.from_json(json_object: json_object)
+               when "request-failed"
+                 Vapi::ToolMessageFailed.from_json(json_object: json_object)
+               when "request-response-delayed"
+                 Vapi::ToolMessageDelayed.from_json(json_object: json_object)
+               else
+                 Vapi::ToolMessageStart.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 "request-start"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-complete"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-failed"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-response-delayed"
+        { **@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 "request-start"
+        Vapi::ToolMessageStart.validate_raw(obj: obj)
+      when "request-complete"
+        Vapi::ToolMessageComplete.validate_raw(obj: obj)
+      when "request-failed"
+        Vapi::ToolMessageFailed.validate_raw(obj: obj)
+      when "request-response-delayed"
+        Vapi::ToolMessageDelayed.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::ToolMessageStart]
+    # @return [Vapi::CreateDtmfToolDtoMessagesItem]
+    def self.request_start(member:)
+      new(member: member, discriminant: "request-start")
+    end
+
+    # @param member [Vapi::ToolMessageComplete]
+    # @return [Vapi::CreateDtmfToolDtoMessagesItem]
+    def self.request_complete(member:)
+      new(member: member, discriminant: "request-complete")
+    end
+
+    # @param member [Vapi::ToolMessageFailed]
+    # @return [Vapi::CreateDtmfToolDtoMessagesItem]
+    def self.request_failed(member:)
+      new(member: member, discriminant: "request-failed")
+    end
+
+    # @param member [Vapi::ToolMessageDelayed]
+    # @return [Vapi::CreateDtmfToolDtoMessagesItem]
+    def self.request_response_delayed(member:)
+      new(member: member, discriminant: "request-response-delayed")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_eleven_labs_credential_dto.rb

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

data/lib/vapi_server_sdk/types/create_end_call_tool_dto.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require_relative "create_end_call_tool_dto_messages_item"
+require_relative "open_ai_function"
+require_relative "server"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateEndCallToolDto
+    # @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::CreateEndCallToolDtoMessagesItem>] 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 [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::CreateEndCallToolDtoMessagesItem>] 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 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::CreateEndCallToolDto]
+    def initialize(async: OMIT, messages: OMIT, function: OMIT, server: OMIT, additional_properties: nil)
+      @async = async if async != OMIT
+      @messages = messages if messages != OMIT
+      @function = function if function != OMIT
+      @server = server if server != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "async": async, "messages": messages, "function": function, "server": server }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateEndCallToolDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateEndCallToolDto]
+    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::CreateEndCallToolDtoMessagesItem.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,
+        function: function,
+        server: server,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateEndCallToolDto 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.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/create_end_call_tool_dto_messages_item.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "tool_message_start"
+require_relative "tool_message_complete"
+require_relative "tool_message_failed"
+require_relative "tool_message_delayed"
+
+module Vapi
+  class CreateEndCallToolDtoMessagesItem
+    # @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::CreateEndCallToolDtoMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of CreateEndCallToolDtoMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateEndCallToolDtoMessagesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "request-start"
+                 Vapi::ToolMessageStart.from_json(json_object: json_object)
+               when "request-complete"
+                 Vapi::ToolMessageComplete.from_json(json_object: json_object)
+               when "request-failed"
+                 Vapi::ToolMessageFailed.from_json(json_object: json_object)
+               when "request-response-delayed"
+                 Vapi::ToolMessageDelayed.from_json(json_object: json_object)
+               else
+                 Vapi::ToolMessageStart.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 "request-start"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-complete"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-failed"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-response-delayed"
+        { **@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 "request-start"
+        Vapi::ToolMessageStart.validate_raw(obj: obj)
+      when "request-complete"
+        Vapi::ToolMessageComplete.validate_raw(obj: obj)
+      when "request-failed"
+        Vapi::ToolMessageFailed.validate_raw(obj: obj)
+      when "request-response-delayed"
+        Vapi::ToolMessageDelayed.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::ToolMessageStart]
+    # @return [Vapi::CreateEndCallToolDtoMessagesItem]
+    def self.request_start(member:)
+      new(member: member, discriminant: "request-start")
+    end
+
+    # @param member [Vapi::ToolMessageComplete]
+    # @return [Vapi::CreateEndCallToolDtoMessagesItem]
+    def self.request_complete(member:)
+      new(member: member, discriminant: "request-complete")
+    end
+
+    # @param member [Vapi::ToolMessageFailed]
+    # @return [Vapi::CreateEndCallToolDtoMessagesItem]
+    def self.request_failed(member:)
+      new(member: member, discriminant: "request-failed")
+    end
+
+    # @param member [Vapi::ToolMessageDelayed]
+    # @return [Vapi::CreateEndCallToolDtoMessagesItem]
+    def self.request_response_delayed(member:)
+      new(member: member, discriminant: "request-response-delayed")
+    end
+  end
+end