vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/transfer_call_tool.rb

@@ -4,19 +4,11 @@ require_relative "transfer_call_tool_messages_item"
 require_relative "transfer_call_tool_destinations_item"
 require "date"
 require_relative "open_ai_function"
-require_relative "server"
 require "ostruct"
 require "json"
 
 module Vapi
   class TransferCallTool
-    # @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::TransferCallToolMessagesItem>] 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
@@ -44,13 +36,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]
@@ -59,12 +44,6 @@ 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::TransferCallToolMessagesItem>] 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
@@ -85,17 +64,10 @@ 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::TransferCallTool]
-    def initialize(id:, org_id:, created_at:, updated_at:, async: OMIT, messages: OMIT, destinations: OMIT,
-                   function: OMIT, server: OMIT, additional_properties: nil)
-      @async = async if async != OMIT
+    def initialize(id:, org_id:, created_at:, updated_at:, messages: OMIT, destinations: OMIT, function: OMIT,
+                   additional_properties: nil)
       @messages = messages if messages != OMIT
       @destinations = destinations if destinations != OMIT
       @id = id
@@ -103,18 +75,15 @@ module Vapi
       @created_at = created_at
       @updated_at = updated_at
       @function = function if function != OMIT
-      @server = server if server != OMIT
       @additional_properties = additional_properties
       @_field_set = {
-        "async": async,
         "messages": messages,
         "destinations": destinations,
         "id": id,
         "orgId": org_id,
         "createdAt": created_at,
         "updatedAt": updated_at,
-        "function": function,
-        "server": server
+        "function": function
       }.reject do |_k, v|
         v == OMIT
       end
@@ -127,7 +96,6 @@ 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::TransferCallToolMessagesItem.from_json(json_object: item)
@@ -146,14 +114,7 @@ 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,
         destinations: destinations,
         id: id,
@@ -161,7 +122,6 @@ module Vapi
         created_at: created_at,
         updated_at: updated_at,
         function: function,
-        server: server,
         additional_properties: struct
       )
     end
@@ -180,7 +140,6 @@ 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.destinations&.is_a?(Array) != false || raise("Passed value for field obj.destinations is not the expected type, validation failed.")
       obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
@@ -188,7 +147,6 @@ module Vapi
       obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
       obj.updated_at.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at 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/transfer_call_tool_destinations_item.rb

@@ -2,7 +2,6 @@
 
 require "json"
 require_relative "transfer_destination_assistant"
-require_relative "transfer_destination_step"
 require_relative "transfer_destination_number"
 require_relative "transfer_destination_sip"
 
@@ -33,8 +32,6 @@ module Vapi
       member = case struct.type
                when "assistant"
                  Vapi::TransferDestinationAssistant.from_json(json_object: json_object)
-               when "step"
-                 Vapi::TransferDestinationStep.from_json(json_object: json_object)
                when "number"
                  Vapi::TransferDestinationNumber.from_json(json_object: json_object)
                when "sip"
@@ -52,8 +49,6 @@ module Vapi
       case @discriminant
       when "assistant"
         { **@member.to_json, type: @discriminant }.to_json
-      when "step"
-        { **@member.to_json, type: @discriminant }.to_json
       when "number"
         { **@member.to_json, type: @discriminant }.to_json
       when "sip"
@@ -74,8 +69,6 @@ module Vapi
       case obj.type
       when "assistant"
         Vapi::TransferDestinationAssistant.validate_raw(obj: obj)
-      when "step"
-        Vapi::TransferDestinationStep.validate_raw(obj: obj)
       when "number"
         Vapi::TransferDestinationNumber.validate_raw(obj: obj)
       when "sip"
@@ -99,12 +92,6 @@ module Vapi
       new(member: member, discriminant: "assistant")
     end
 
-    # @param member [Vapi::TransferDestinationStep]
-    # @return [Vapi::TransferCallToolDestinationsItem]
-    def self.step(member:)
-      new(member: member, discriminant: "step")
-    end
-
     # @param member [Vapi::TransferDestinationNumber]
     # @return [Vapi::TransferCallToolDestinationsItem]
     def self.number(member:)

data/lib/vapi_server_sdk/types/transfer_destination_assistant.rb

@@ -75,6 +75,29 @@ module Vapi
     #  user: Yes, please
     #  assistant: how can i help?
     #  user: i need help with my account
+    #  - `swap-system-message-in-history-and-remove-transfer-tool-messages`: This
+    #  replaces the original system message with the new assistant's system message on
+    #  transfer and removes transfer tool messages from conversation history sent to
+    #  the LLM.
+    #  Example:
+    #  Pre-transfer:
+    #  system: assistant1 system message
+    #  assistant: assistant1 first message
+    #  user: hey, good morning
+    #  assistant: how can i help?
+    #  user: i need help with my account
+    #  transfer-tool
+    #  transfer-tool-result
+    #  assistant: (destination.message)
+    #  Post-transfer:
+    #  system: assistant2 system message
+    #  assistant: assistant1 first message
+    #  user: hey, good morning
+    #  assistant: how can i help?
+    #  user: i need help with my account
+    #  assistant: (destination.message)
+    #  assistant: assistant2 first message (or model generated if firstMessageMode
+    #  is set to `assistant-speaks-first-with-model-generated-message`)
     #  @default 'rolling-history'
     attr_reader :transfer_mode
     # @return [String] This is the assistant to transfer the call to.
@@ -157,6 +180,29 @@ module Vapi
     #  user: Yes, please
     #  assistant: how can i help?
     #  user: i need help with my account
+    #  - `swap-system-message-in-history-and-remove-transfer-tool-messages`: This
+    #  replaces the original system message with the new assistant's system message on
+    #  transfer and removes transfer tool messages from conversation history sent to
+    #  the LLM.
+    #  Example:
+    #  Pre-transfer:
+    #  system: assistant1 system message
+    #  assistant: assistant1 first message
+    #  user: hey, good morning
+    #  assistant: how can i help?
+    #  user: i need help with my account
+    #  transfer-tool
+    #  transfer-tool-result
+    #  assistant: (destination.message)
+    #  Post-transfer:
+    #  system: assistant2 system message
+    #  assistant: assistant1 first message
+    #  user: hey, good morning
+    #  assistant: how can i help?
+    #  user: i need help with my account
+    #  assistant: (destination.message)
+    #  assistant: assistant2 first message (or model generated if firstMessageMode
+    #  is set to `assistant-speaks-first-with-model-generated-message`)
     #  @default 'rolling-history'
     # @param assistant_name [String] This is the assistant to transfer the call to.
     # @param description [String] This is the description of the destination, used by the AI to choose when and

data/lib/vapi_server_sdk/types/transfer_fallback_plan.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative "transfer_fallback_plan_message"
+require "ostruct"
+require "json"
+
+module Vapi
+  class TransferFallbackPlan
+    # @return [Vapi::TransferFallbackPlanMessage] This is the message the assistant will deliver to the customer if the transfer
+    #  fails.
+    attr_reader :message
+    # @return [Boolean] This controls what happens after delivering the failure message to the customer.
+    #  - true: End the call after delivering the failure message (default)
+    #  - false: Keep the assistant on the call to continue handling the customer's
+    #  request
+    #  @default true
+    attr_reader :end_call_enabled
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param message [Vapi::TransferFallbackPlanMessage] This is the message the assistant will deliver to the customer if the transfer
+    #  fails.
+    # @param end_call_enabled [Boolean] This controls what happens after delivering the failure message to the customer.
+    #  - true: End the call after delivering the failure message (default)
+    #  - false: Keep the assistant on the call to continue handling the customer's
+    #  request
+    #  @default true
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::TransferFallbackPlan]
+    def initialize(message:, end_call_enabled: OMIT, additional_properties: nil)
+      @message = message
+      @end_call_enabled = end_call_enabled if end_call_enabled != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "message": message, "endCallEnabled": end_call_enabled }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of TransferFallbackPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::TransferFallbackPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["message"].nil?
+        message = nil
+      else
+        message = parsed_json["message"].to_json
+        message = Vapi::TransferFallbackPlanMessage.from_json(json_object: message)
+      end
+      end_call_enabled = parsed_json["endCallEnabled"]
+      new(
+        message: message,
+        end_call_enabled: end_call_enabled,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of TransferFallbackPlan 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:)
+      Vapi::TransferFallbackPlanMessage.validate_raw(obj: obj.message)
+      obj.end_call_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.end_call_enabled is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/{fallback_neets_voice_id.rb → transfer_fallback_plan_message.rb}

@@ -1,18 +1,20 @@
 # frozen_string_literal: true
 
 require "json"
+require_relative "custom_message"
 
 module Vapi
-  # This is the provider-specific ID that will be used.
-  class FallbackNeetsVoiceId
-    # Deserialize a JSON object to an instance of FallbackNeetsVoiceId
+  # This is the message the assistant will deliver to the customer if the transfer
+  #  fails.
+  class TransferFallbackPlanMessage
+    # Deserialize a JSON object to an instance of TransferFallbackPlanMessage
     #
     # @param json_object [String]
-    # @return [Vapi::FallbackNeetsVoiceId]
+    # @return [Vapi::TransferFallbackPlanMessage]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       begin
-        struct.is_a?(Vapi::FallbackNeetsVoiceIdEnum) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+        struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
         return struct unless struct.nil?
 
         return nil
@@ -20,8 +22,8 @@ module Vapi
         # noop
       end
       begin
-        struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
-        return struct unless struct.nil?
+        Vapi::CustomMessage.validate_raw(obj: struct)
+        return Vapi::CustomMessage.from_json(json_object: struct) unless struct.nil?
 
         return nil
       rescue StandardError
@@ -38,12 +40,12 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       begin
-        return obj.is_a?(Vapi::FallbackNeetsVoiceIdEnum) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+        return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
       rescue StandardError
         # noop
       end
       begin
-        return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+        return Vapi::CustomMessage.validate_raw(obj: obj)
       rescue StandardError
         # noop
       end

data/lib/vapi_server_sdk/types/transfer_phone_number_hook_action.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "transfer_phone_number_hook_action_destination"
+require "ostruct"
+require "json"
+
+module Vapi
+  class TransferPhoneNumberHookAction
+    # @return [Vapi::TransferPhoneNumberHookActionDestination] This is the destination details for the transfer - can be a phone number or SIP
+    #  URI
+    attr_reader :destination
+    # @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 destination [Vapi::TransferPhoneNumberHookActionDestination] This is the destination details for the transfer - can be a phone number or SIP
+    #  URI
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::TransferPhoneNumberHookAction]
+    def initialize(destination: OMIT, additional_properties: nil)
+      @destination = destination if destination != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "destination": destination }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of TransferPhoneNumberHookAction
+    #
+    # @param json_object [String]
+    # @return [Vapi::TransferPhoneNumberHookAction]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["destination"].nil?
+        destination = nil
+      else
+        destination = parsed_json["destination"].to_json
+        destination = Vapi::TransferPhoneNumberHookActionDestination.from_json(json_object: destination)
+      end
+      new(destination: destination, additional_properties: struct)
+    end
+
+    # Serialize an instance of TransferPhoneNumberHookAction 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.destination.nil? || Vapi::TransferPhoneNumberHookActionDestination.validate_raw(obj: obj.destination)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/{create_trieve_knowledge_base_dto_create_plan.rb → transfer_phone_number_hook_action_destination.rb}

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 require "json"
-require_relative "trieve_knowledge_base_create"
-require_relative "trieve_knowledge_base_import"
+require_relative "transfer_destination_number"
+require_relative "transfer_destination_sip"
 
 module Vapi
-  # This is the plan if you want us to create/import a new vector store using
-  #  Trieve.
-  class CreateTrieveKnowledgeBaseDtoCreatePlan
+  # This is the destination details for the transfer - can be a phone number or SIP
+  #  URI
+  class TransferPhoneNumberHookActionDestination
     # @return [Object]
     attr_reader :member
     # @return [String]
@@ -18,26 +18,26 @@ module Vapi
 
     # @param member [Object]
     # @param discriminant [String]
-    # @return [Vapi::CreateTrieveKnowledgeBaseDtoCreatePlan]
+    # @return [Vapi::TransferPhoneNumberHookActionDestination]
     def initialize(member:, discriminant:)
       @member = member
       @discriminant = discriminant
     end
 
     # Deserialize a JSON object to an instance of
-    #  CreateTrieveKnowledgeBaseDtoCreatePlan
+    #  TransferPhoneNumberHookActionDestination
     #
     # @param json_object [String]
-    # @return [Vapi::CreateTrieveKnowledgeBaseDtoCreatePlan]
+    # @return [Vapi::TransferPhoneNumberHookActionDestination]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       member = case struct.type
-               when "create"
-                 Vapi::TrieveKnowledgeBaseCreate.from_json(json_object: json_object)
-               when "import"
-                 Vapi::TrieveKnowledgeBaseImport.from_json(json_object: json_object)
+               when "number"
+                 Vapi::TransferDestinationNumber.from_json(json_object: json_object)
+               when "sip"
+                 Vapi::TransferDestinationSip.from_json(json_object: json_object)
                else
-                 Vapi::TrieveKnowledgeBaseCreate.from_json(json_object: json_object)
+                 Vapi::TransferDestinationNumber.from_json(json_object: json_object)
                end
       new(member: member, discriminant: struct.type)
     end
@@ -47,9 +47,9 @@ module Vapi
     # @return [String]
     def to_json(*_args)
       case @discriminant
-      when "create"
+      when "number"
         { **@member.to_json, type: @discriminant }.to_json
-      when "import"
+      when "sip"
         { **@member.to_json, type: @discriminant }.to_json
       else
         { "type": @discriminant, value: @member }.to_json
@@ -65,10 +65,10 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       case obj.type
-      when "create"
-        Vapi::TrieveKnowledgeBaseCreate.validate_raw(obj: obj)
-      when "import"
-        Vapi::TrieveKnowledgeBaseImport.validate_raw(obj: obj)
+      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
@@ -82,16 +82,16 @@ module Vapi
       @member.is_a?(obj)
     end
 
-    # @param member [Vapi::TrieveKnowledgeBaseCreate]
-    # @return [Vapi::CreateTrieveKnowledgeBaseDtoCreatePlan]
-    def self.create(member:)
-      new(member: member, discriminant: "create")
+    # @param member [Vapi::TransferDestinationNumber]
+    # @return [Vapi::TransferPhoneNumberHookActionDestination]
+    def self.number(member:)
+      new(member: member, discriminant: "number")
     end
 
-    # @param member [Vapi::TrieveKnowledgeBaseImport]
-    # @return [Vapi::CreateTrieveKnowledgeBaseDtoCreatePlan]
-    def self.import(member:)
-      new(member: member, discriminant: "import")
+    # @param member [Vapi::TransferDestinationSip]
+    # @return [Vapi::TransferPhoneNumberHookActionDestination]
+    def self.sip(member:)
+      new(member: member, discriminant: "sip")
     end
   end
 end