vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/create_telnyx_phone_number_dto_fallback_destination.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "transfer_destination_number"
+require_relative "transfer_destination_sip"
+
+module Vapi
+  # This is the fallback destination an inbound call will be transferred to if:
+  #  1. `assistantId` is not set
+  #  2. `squadId` is not set
+  #  3. and, `assistant-request` message to the `serverUrl` fails
+  #  If this is not set and above conditions are met, the inbound call is hung up
+  #  with an error message.
+  class CreateTelnyxPhoneNumberDtoFallbackDestination
+    # @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::CreateTelnyxPhoneNumberDtoFallbackDestination]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  CreateTelnyxPhoneNumberDtoFallbackDestination
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateTelnyxPhoneNumberDtoFallbackDestination]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "number"
+                 Vapi::TransferDestinationNumber.from_json(json_object: json_object)
+               when "sip"
+                 Vapi::TransferDestinationSip.from_json(json_object: json_object)
+               else
+                 Vapi::TransferDestinationNumber.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 "number"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "sip"
+        { **@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 "number"
+        Vapi::TransferDestinationNumber.validate_raw(obj: obj)
+      when "sip"
+        Vapi::TransferDestinationSip.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::TransferDestinationNumber]
+    # @return [Vapi::CreateTelnyxPhoneNumberDtoFallbackDestination]
+    def self.number(member:)
+      new(member: member, discriminant: "number")
+    end
+
+    # @param member [Vapi::TransferDestinationSip]
+    # @return [Vapi::CreateTelnyxPhoneNumberDtoFallbackDestination]
+    def self.sip(member:)
+      new(member: member, discriminant: "sip")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_test_suite_test_chat_dto.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative "test_suite_test_scorer_ai"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateTestSuiteTestChatDto
+    # @return [Array<Vapi::TestSuiteTestScorerAi>] These are the scorers used to evaluate the test.
+    attr_reader :scorers
+    # @return [String] This is the script to be used for the chat test.
+    attr_reader :script
+    # @return [Float] This is the number of attempts allowed for the test.
+    attr_reader :num_attempts
+    # @return [String] This is the name of the test.
+    attr_reader :name
+    # @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 scorers [Array<Vapi::TestSuiteTestScorerAi>] These are the scorers used to evaluate the test.
+    # @param script [String] This is the script to be used for the chat test.
+    # @param num_attempts [Float] This is the number of attempts allowed for the test.
+    # @param name [String] This is the name of the test.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateTestSuiteTestChatDto]
+    def initialize(scorers:, script:, num_attempts: OMIT, name: OMIT, additional_properties: nil)
+      @scorers = scorers
+      @script = script
+      @num_attempts = num_attempts if num_attempts != OMIT
+      @name = name if name != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "scorers": scorers,
+        "script": script,
+        "numAttempts": num_attempts,
+        "name": name
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateTestSuiteTestChatDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateTestSuiteTestChatDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      scorers = parsed_json["scorers"]&.map do |item|
+        item = item.to_json
+        Vapi::TestSuiteTestScorerAi.from_json(json_object: item)
+      end
+      script = parsed_json["script"]
+      num_attempts = parsed_json["numAttempts"]
+      name = parsed_json["name"]
+      new(
+        scorers: scorers,
+        script: script,
+        num_attempts: num_attempts,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateTestSuiteTestChatDto 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.scorers.is_a?(Array) != false || raise("Passed value for field obj.scorers is not the expected type, validation failed.")
+      obj.script.is_a?(String) != false || raise("Passed value for field obj.script is not the expected type, validation failed.")
+      obj.num_attempts&.is_a?(Float) != false || raise("Passed value for field obj.num_attempts 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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_test_suite_test_voice_dto.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative "test_suite_test_scorer_ai"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateTestSuiteTestVoiceDto
+    # @return [Array<Vapi::TestSuiteTestScorerAi>] These are the scorers used to evaluate the test.
+    attr_reader :scorers
+    # @return [String] This is the script to be used for the voice test.
+    attr_reader :script
+    # @return [Float] This is the number of attempts allowed for the test.
+    attr_reader :num_attempts
+    # @return [String] This is the name of the test.
+    attr_reader :name
+    # @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 scorers [Array<Vapi::TestSuiteTestScorerAi>] These are the scorers used to evaluate the test.
+    # @param script [String] This is the script to be used for the voice test.
+    # @param num_attempts [Float] This is the number of attempts allowed for the test.
+    # @param name [String] This is the name of the test.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateTestSuiteTestVoiceDto]
+    def initialize(scorers:, script:, num_attempts: OMIT, name: OMIT, additional_properties: nil)
+      @scorers = scorers
+      @script = script
+      @num_attempts = num_attempts if num_attempts != OMIT
+      @name = name if name != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "scorers": scorers,
+        "script": script,
+        "numAttempts": num_attempts,
+        "name": name
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateTestSuiteTestVoiceDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateTestSuiteTestVoiceDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      scorers = parsed_json["scorers"]&.map do |item|
+        item = item.to_json
+        Vapi::TestSuiteTestScorerAi.from_json(json_object: item)
+      end
+      script = parsed_json["script"]
+      num_attempts = parsed_json["numAttempts"]
+      name = parsed_json["name"]
+      new(
+        scorers: scorers,
+        script: script,
+        num_attempts: num_attempts,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateTestSuiteTestVoiceDto 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.scorers.is_a?(Array) != false || raise("Passed value for field obj.scorers is not the expected type, validation failed.")
+      obj.script.is_a?(String) != false || raise("Passed value for field obj.script is not the expected type, validation failed.")
+      obj.num_attempts&.is_a?(Float) != false || raise("Passed value for field obj.num_attempts 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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_text_editor_tool_dto.rb

@@ -1,20 +1,13 @@
 # frozen_string_literal: true
 
 require_relative "create_text_editor_tool_dto_messages_item"
-require_relative "open_ai_function"
 require_relative "server"
+require_relative "open_ai_function"
 require "ostruct"
 require "json"
 
 module Vapi
   class CreateTextEditorToolDto
-    # @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::CreateTextEditorToolDtoMessagesItem>] 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
@@ -22,6 +15,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 [String] The name of the tool, fixed to 'str_replace_editor'
     attr_reader :name
     # @return [Vapi::OpenAiFunction] This is the function definition of the tool.
@@ -34,13 +38,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]
@@ -49,17 +46,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::CreateTextEditorToolDtoMessagesItem>] 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 name [String] The name of the tool, fixed to 'str_replace_editor'
     # @param function [Vapi::OpenAiFunction] This is the function definition of the tool.
     #  For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on
@@ -70,30 +71,21 @@ 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::CreateTextEditorToolDto]
-    def initialize(sub_type:, name:, async: OMIT, messages: OMIT, function: OMIT, server: OMIT,
-                   additional_properties: nil)
-      @async = async if async != OMIT
+    def initialize(sub_type:, name:, messages: OMIT, server: OMIT, function: OMIT, additional_properties: nil)
       @messages = messages if messages != OMIT
       @sub_type = sub_type
+      @server = server if server != OMIT
       @name = name
       @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,
         "name": name,
-        "function": function,
-        "server": server
+        "function": function
       }.reject do |_k, v|
         v == OMIT
       end
@@ -106,12 +98,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::CreateTextEditorToolDtoMessagesItem.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
       name = parsed_json["name"]
       if parsed_json["function"].nil?
         function = nil
@@ -119,19 +116,12 @@ 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,
         name: name,
         function: function,
-        server: server,
         additional_properties: struct
       )
     end
@@ -150,12 +140,11 @@ 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)
       obj.name.is_a?(String) != false || raise("Passed value for field obj.name 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