vapi_server_sdk 0.5.0 → 0.9.1

data/lib/vapi_server_sdk/types/server_message_response_call_endpointing_request.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class ServerMessageResponseCallEndpointingRequest
+    # @return [Float] This is the timeout in seconds to wait before considering the user's speech as
+    #  finished.
+    attr_reader :timeout_seconds
+    # @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 timeout_seconds [Float] This is the timeout in seconds to wait before considering the user's speech as
+    #  finished.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ServerMessageResponseCallEndpointingRequest]
+    def initialize(timeout_seconds:, additional_properties: nil)
+      @timeout_seconds = timeout_seconds
+      @additional_properties = additional_properties
+      @_field_set = { "timeoutSeconds": timeout_seconds }
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  ServerMessageResponseCallEndpointingRequest
+    #
+    # @param json_object [String]
+    # @return [Vapi::ServerMessageResponseCallEndpointingRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      timeout_seconds = parsed_json["timeoutSeconds"]
+      new(timeout_seconds: timeout_seconds, additional_properties: struct)
+    end
+
+    # Serialize an instance of ServerMessageResponseCallEndpointingRequest 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.timeout_seconds.is_a?(Float) != false || raise("Passed value for field obj.timeout_seconds is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/server_message_response_message_response.rb

@@ -6,6 +6,7 @@ require_relative "server_message_response_knowledge_base_request"
 require_relative "server_message_response_tool_calls"
 require_relative "server_message_response_transfer_destination_request"
 require_relative "server_message_response_voice_request"
+require_relative "server_message_response_call_endpointing_request"
 
 module Vapi
   # This is the response that is expected from the server to the message.
@@ -58,6 +59,14 @@ module Vapi
       rescue StandardError
         # noop
       end
+      begin
+        Vapi::ServerMessageResponseCallEndpointingRequest.validate_raw(obj: struct)
+        return Vapi::ServerMessageResponseCallEndpointingRequest.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
       struct
     end
 
@@ -93,6 +102,11 @@ module Vapi
       rescue StandardError
         # noop
       end
+      begin
+        return Vapi::ServerMessageResponseCallEndpointingRequest.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
       raise("Passed value matched no type within the union, validation failed.")
     end
   end

data/lib/vapi_server_sdk/types/server_message_response_transfer_destination_request.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "server_message_response_transfer_destination_request_destination"
+require_relative "server_message_response_transfer_destination_request_message"
 require "ostruct"
 require "json"
 
@@ -8,6 +9,8 @@ module Vapi
   class ServerMessageResponseTransferDestinationRequest
     # @return [Vapi::ServerMessageResponseTransferDestinationRequestDestination] This is the destination you'd like the call to be transferred to.
     attr_reader :destination
+    # @return [Vapi::ServerMessageResponseTransferDestinationRequestMessage] This is the message that will be spoken to the user as the tool is running.
+    attr_reader :message
     # @return [String] This is the error message if the transfer should not be made.
     attr_reader :error
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -19,14 +22,16 @@ module Vapi
     OMIT = Object.new
 
     # @param destination [Vapi::ServerMessageResponseTransferDestinationRequestDestination] This is the destination you'd like the call to be transferred to.
+    # @param message [Vapi::ServerMessageResponseTransferDestinationRequestMessage] This is the message that will be spoken to the user as the tool is running.
     # @param error [String] This is the error message if the transfer should not be made.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ServerMessageResponseTransferDestinationRequest]
-    def initialize(destination: OMIT, error: OMIT, additional_properties: nil)
+    def initialize(destination: OMIT, message: OMIT, error: OMIT, additional_properties: nil)
       @destination = destination if destination != OMIT
+      @message = message if message != OMIT
       @error = error if error != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "destination": destination, "error": error }.reject do |_k, v|
+      @_field_set = { "destination": destination, "message": message, "error": error }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -45,9 +50,16 @@ module Vapi
         destination = parsed_json["destination"].to_json
         destination = Vapi::ServerMessageResponseTransferDestinationRequestDestination.from_json(json_object: destination)
       end
+      if parsed_json["message"].nil?
+        message = nil
+      else
+        message = parsed_json["message"].to_json
+        message = Vapi::ServerMessageResponseTransferDestinationRequestMessage.from_json(json_object: message)
+      end
       error = parsed_json["error"]
       new(
         destination: destination,
+        message: message,
         error: error,
         additional_properties: struct
       )
@@ -69,6 +81,7 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.destination.nil? || Vapi::ServerMessageResponseTransferDestinationRequestDestination.validate_raw(obj: obj.destination)
+      obj.message.nil? || Vapi::ServerMessageResponseTransferDestinationRequestMessage.validate_raw(obj: obj.message)
       obj.error&.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
     end
   end

data/lib/vapi_server_sdk/types/server_message_response_transfer_destination_request_destination.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"
 
@@ -35,8 +34,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"
@@ -54,8 +51,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"
@@ -76,8 +71,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"
@@ -101,12 +94,6 @@ module Vapi
       new(member: member, discriminant: "assistant")
     end
 
-    # @param member [Vapi::TransferDestinationStep]
-    # @return [Vapi::ServerMessageResponseTransferDestinationRequestDestination]
-    def self.step(member:)
-      new(member: member, discriminant: "step")
-    end
-
     # @param member [Vapi::TransferDestinationNumber]
     # @return [Vapi::ServerMessageResponseTransferDestinationRequestDestination]
     def self.number(member:)

data/lib/vapi_server_sdk/types/server_message_response_transfer_destination_request_message.rb

@@ -0,0 +1,122 @@
+# 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
+  # This is the message that will be spoken to the user as the tool is running.
+  class ServerMessageResponseTransferDestinationRequestMessage
+    # @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::ServerMessageResponseTransferDestinationRequestMessage]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  ServerMessageResponseTransferDestinationRequestMessage
+    #
+    # @param json_object [String]
+    # @return [Vapi::ServerMessageResponseTransferDestinationRequestMessage]
+    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::ServerMessageResponseTransferDestinationRequestMessage]
+    def self.request_start(member:)
+      new(member: member, discriminant: "request-start")
+    end
+
+    # @param member [Vapi::ToolMessageComplete]
+    # @return [Vapi::ServerMessageResponseTransferDestinationRequestMessage]
+    def self.request_complete(member:)
+      new(member: member, discriminant: "request-complete")
+    end
+
+    # @param member [Vapi::ToolMessageFailed]
+    # @return [Vapi::ServerMessageResponseTransferDestinationRequestMessage]
+    def self.request_failed(member:)
+      new(member: member, discriminant: "request-failed")
+    end
+
+    # @param member [Vapi::ToolMessageDelayed]
+    # @return [Vapi::ServerMessageResponseTransferDestinationRequestMessage]
+    def self.request_response_delayed(member:)
+      new(member: member, discriminant: "request-response-delayed")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/server_message_speech_update.rb

@@ -7,48 +7,33 @@ require_relative "artifact"
 require_relative "create_assistant_dto"
 require_relative "create_customer_dto"
 require_relative "call"
+require_relative "chat"
 require "ostruct"
 require "json"
 
 module Vapi
   class ServerMessageSpeechUpdate
-    # @return [Vapi::ServerMessageSpeechUpdatePhoneNumber] This is the phone number associated with the call.
-    #  This matches one of the following:
-    #  - `call.phoneNumber`,
-    #  - `call.phoneNumberId`.
+    # @return [Vapi::ServerMessageSpeechUpdatePhoneNumber] This is the phone number that the message is associated with.
     attr_reader :phone_number
-    # @return [String] This is the type of the message. "speech-update" is sent whenever assistant or
-    #  user start or stop speaking.
-    attr_reader :type
     # @return [Vapi::ServerMessageSpeechUpdateStatus] This is the status of the speech update.
     attr_reader :status
     # @return [Vapi::ServerMessageSpeechUpdateRole] This is the role which the speech update is for.
     attr_reader :role
-    # @return [String] This is the ISO-8601 formatted timestamp of when the message was sent.
+    # @return [Float] This is the turn number of the speech update (0-indexed).
+    attr_reader :turn
+    # @return [Float] This is the timestamp of the message.
     attr_reader :timestamp
     # @return [Vapi::Artifact] This is a live version of the `call.artifact`.
     #  This matches what is stored on `call.artifact` after the call.
     attr_reader :artifact
-    # @return [Vapi::CreateAssistantDto] This is the assistant that is currently active. This is provided for
-    #  convenience.
-    #  This matches one of the following:
-    #  - `call.assistant`,
-    #  - `call.assistantId`,
-    #  - `call.squad[n].assistant`,
-    #  - `call.squad[n].assistantId`,
-    #  - `call.squadId->[n].assistant`,
-    #  - `call.squadId->[n].assistantId`.
+    # @return [Vapi::CreateAssistantDto] This is the assistant that the message is associated with.
     attr_reader :assistant
-    # @return [Vapi::CreateCustomerDto] This is the customer associated with the call.
-    #  This matches one of the following:
-    #  - `call.customer`,
-    #  - `call.customerId`.
+    # @return [Vapi::CreateCustomerDto] This is the customer that the message is associated with.
     attr_reader :customer
-    # @return [Vapi::Call] This is the call object.
-    #  This matches what was returned in POST /call.
-    #  Note: This might get stale during the call. To get the latest call object,
-    #  especially after the call is ended, use GET /call/:id.
+    # @return [Vapi::Call] This is the call that the message is associated with.
     attr_reader :call
+    # @return [Vapi::Chat] This is the chat object.
+    attr_reader :chat
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -57,58 +42,43 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param phone_number [Vapi::ServerMessageSpeechUpdatePhoneNumber] This is the phone number associated with the call.
-    #  This matches one of the following:
-    #  - `call.phoneNumber`,
-    #  - `call.phoneNumberId`.
-    # @param type [String] This is the type of the message. "speech-update" is sent whenever assistant or
-    #  user start or stop speaking.
+    # @param phone_number [Vapi::ServerMessageSpeechUpdatePhoneNumber] This is the phone number that the message is associated with.
     # @param status [Vapi::ServerMessageSpeechUpdateStatus] This is the status of the speech update.
     # @param role [Vapi::ServerMessageSpeechUpdateRole] This is the role which the speech update is for.
-    # @param timestamp [String] This is the ISO-8601 formatted timestamp of when the message was sent.
+    # @param turn [Float] This is the turn number of the speech update (0-indexed).
+    # @param timestamp [Float] This is the timestamp of the message.
     # @param artifact [Vapi::Artifact] This is a live version of the `call.artifact`.
     #  This matches what is stored on `call.artifact` after the call.
-    # @param assistant [Vapi::CreateAssistantDto] This is the assistant that is currently active. This is provided for
-    #  convenience.
-    #  This matches one of the following:
-    #  - `call.assistant`,
-    #  - `call.assistantId`,
-    #  - `call.squad[n].assistant`,
-    #  - `call.squad[n].assistantId`,
-    #  - `call.squadId->[n].assistant`,
-    #  - `call.squadId->[n].assistantId`.
-    # @param customer [Vapi::CreateCustomerDto] This is the customer associated with the call.
-    #  This matches one of the following:
-    #  - `call.customer`,
-    #  - `call.customerId`.
-    # @param call [Vapi::Call] This is the call object.
-    #  This matches what was returned in POST /call.
-    #  Note: This might get stale during the call. To get the latest call object,
-    #  especially after the call is ended, use GET /call/:id.
+    # @param assistant [Vapi::CreateAssistantDto] This is the assistant that the message is associated with.
+    # @param customer [Vapi::CreateCustomerDto] This is the customer that the message is associated with.
+    # @param call [Vapi::Call] This is the call that the message is associated with.
+    # @param chat [Vapi::Chat] This is the chat object.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ServerMessageSpeechUpdate]
-    def initialize(type:, status:, role:, phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT,
-                   customer: OMIT, call: OMIT, additional_properties: nil)
+    def initialize(status:, role:, phone_number: OMIT, turn: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT,
+                   customer: OMIT, call: OMIT, chat: OMIT, additional_properties: nil)
       @phone_number = phone_number if phone_number != OMIT
-      @type = type
       @status = status
       @role = role
+      @turn = turn if turn != OMIT
       @timestamp = timestamp if timestamp != OMIT
       @artifact = artifact if artifact != OMIT
       @assistant = assistant if assistant != OMIT
       @customer = customer if customer != OMIT
       @call = call if call != OMIT
+      @chat = chat if chat != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "phoneNumber": phone_number,
-        "type": type,
         "status": status,
         "role": role,
+        "turn": turn,
         "timestamp": timestamp,
         "artifact": artifact,
         "assistant": assistant,
         "customer": customer,
-        "call": call
+        "call": call,
+        "chat": chat
       }.reject do |_k, v|
         v == OMIT
       end
@@ -127,9 +97,9 @@ module Vapi
         phone_number = parsed_json["phoneNumber"].to_json
         phone_number = Vapi::ServerMessageSpeechUpdatePhoneNumber.from_json(json_object: phone_number)
       end
-      type = parsed_json["type"]
       status = parsed_json["status"]
       role = parsed_json["role"]
+      turn = parsed_json["turn"]
       timestamp = parsed_json["timestamp"]
       if parsed_json["artifact"].nil?
         artifact = nil
@@ -155,16 +125,23 @@ module Vapi
         call = parsed_json["call"].to_json
         call = Vapi::Call.from_json(json_object: call)
       end
+      if parsed_json["chat"].nil?
+        chat = nil
+      else
+        chat = parsed_json["chat"].to_json
+        chat = Vapi::Chat.from_json(json_object: chat)
+      end
       new(
         phone_number: phone_number,
-        type: type,
         status: status,
         role: role,
+        turn: turn,
         timestamp: timestamp,
         artifact: artifact,
         assistant: assistant,
         customer: customer,
         call: call,
+        chat: chat,
         additional_properties: struct
       )
     end
@@ -184,14 +161,15 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.phone_number.nil? || Vapi::ServerMessageSpeechUpdatePhoneNumber.validate_raw(obj: obj.phone_number)
-      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       obj.status.is_a?(Vapi::ServerMessageSpeechUpdateStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
       obj.role.is_a?(Vapi::ServerMessageSpeechUpdateRole) != false || raise("Passed value for field obj.role is not the expected type, validation failed.")
-      obj.timestamp&.is_a?(String) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
+      obj.turn&.is_a?(Float) != false || raise("Passed value for field obj.turn is not the expected type, validation failed.")
+      obj.timestamp&.is_a?(Float) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
       obj.artifact.nil? || Vapi::Artifact.validate_raw(obj: obj.artifact)
       obj.assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.assistant)
       obj.customer.nil? || Vapi::CreateCustomerDto.validate_raw(obj: obj.customer)
       obj.call.nil? || Vapi::Call.validate_raw(obj: obj.call)
+      obj.chat.nil? || Vapi::Chat.validate_raw(obj: obj.chat)
     end
   end
 end

data/lib/vapi_server_sdk/types/server_message_speech_update_phone_number.rb

@@ -5,12 +5,10 @@ require_relative "create_byo_phone_number_dto"
 require_relative "create_twilio_phone_number_dto"
 require_relative "create_vonage_phone_number_dto"
 require_relative "create_vapi_phone_number_dto"
+require_relative "create_telnyx_phone_number_dto"
 
 module Vapi
-  # This is the phone number associated with the call.
-  #  This matches one of the following:
-  #  - `call.phoneNumber`,
-  #  - `call.phoneNumberId`.
+  # This is the phone number that the message is associated with.
   class ServerMessageSpeechUpdatePhoneNumber
     # @return [Object]
     attr_reader :member
@@ -43,6 +41,8 @@ module Vapi
                  Vapi::CreateVonagePhoneNumberDto.from_json(json_object: json_object)
                when "vapi"
                  Vapi::CreateVapiPhoneNumberDto.from_json(json_object: json_object)
+               when "telnyx"
+                 Vapi::CreateTelnyxPhoneNumberDto.from_json(json_object: json_object)
                else
                  Vapi::CreateByoPhoneNumberDto.from_json(json_object: json_object)
                end
@@ -62,6 +62,8 @@ module Vapi
         { **@member.to_json, provider: @discriminant }.to_json
       when "vapi"
         { **@member.to_json, provider: @discriminant }.to_json
+      when "telnyx"
+        { **@member.to_json, provider: @discriminant }.to_json
       else
         { "provider": @discriminant, value: @member }.to_json
       end
@@ -84,6 +86,8 @@ module Vapi
         Vapi::CreateVonagePhoneNumberDto.validate_raw(obj: obj)
       when "vapi"
         Vapi::CreateVapiPhoneNumberDto.validate_raw(obj: obj)
+      when "telnyx"
+        Vapi::CreateTelnyxPhoneNumberDto.validate_raw(obj: obj)
       else
         raise("Passed value matched no type within the union, validation failed.")
       end
@@ -120,5 +124,11 @@ module Vapi
     def self.vapi(member:)
       new(member: member, discriminant: "vapi")
     end
+
+    # @param member [Vapi::CreateTelnyxPhoneNumberDto]
+    # @return [Vapi::ServerMessageSpeechUpdatePhoneNumber]
+    def self.telnyx(member:)
+      new(member: member, discriminant: "telnyx")
+    end
   end
 end