vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/server_message_language_changed_phone_number.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require "json"
+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"
+
+module Vapi
+  # This is the phone number associated with the call.
+  #  This matches one of the following:
+  #  - `call.phoneNumber`,
+  #  - `call.phoneNumberId`.
+  class ServerMessageLanguageChangedPhoneNumber
+    # @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::ServerMessageLanguageChangedPhoneNumber]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  ServerMessageLanguageChangedPhoneNumber
+    #
+    # @param json_object [String]
+    # @return [Vapi::ServerMessageLanguageChangedPhoneNumber]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.provider
+               when "byo-phone-number"
+                 Vapi::CreateByoPhoneNumberDto.from_json(json_object: json_object)
+               when "twilio"
+                 Vapi::CreateTwilioPhoneNumberDto.from_json(json_object: json_object)
+               when "vonage"
+                 Vapi::CreateVonagePhoneNumberDto.from_json(json_object: json_object)
+               when "vapi"
+                 Vapi::CreateVapiPhoneNumberDto.from_json(json_object: json_object)
+               else
+                 Vapi::CreateByoPhoneNumberDto.from_json(json_object: json_object)
+               end
+      new(member: member, discriminant: struct.provider)
+    end
+
+    # For Union Types, to_json functionality is delegated to the wrapped member.
+    #
+    # @return [String]
+    def to_json(*_args)
+      case @discriminant
+      when "byo-phone-number"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "twilio"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "vonage"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "vapi"
+        { **@member.to_json, provider: @discriminant }.to_json
+      else
+        { "provider": @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.provider
+      when "byo-phone-number"
+        Vapi::CreateByoPhoneNumberDto.validate_raw(obj: obj)
+      when "twilio"
+        Vapi::CreateTwilioPhoneNumberDto.validate_raw(obj: obj)
+      when "vonage"
+        Vapi::CreateVonagePhoneNumberDto.validate_raw(obj: obj)
+      when "vapi"
+        Vapi::CreateVapiPhoneNumberDto.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::CreateByoPhoneNumberDto]
+    # @return [Vapi::ServerMessageLanguageChangedPhoneNumber]
+    def self.byo_phone_number(member:)
+      new(member: member, discriminant: "byo-phone-number")
+    end
+
+    # @param member [Vapi::CreateTwilioPhoneNumberDto]
+    # @return [Vapi::ServerMessageLanguageChangedPhoneNumber]
+    def self.twilio(member:)
+      new(member: member, discriminant: "twilio")
+    end
+
+    # @param member [Vapi::CreateVonagePhoneNumberDto]
+    # @return [Vapi::ServerMessageLanguageChangedPhoneNumber]
+    def self.vonage(member:)
+      new(member: member, discriminant: "vonage")
+    end
+
+    # @param member [Vapi::CreateVapiPhoneNumberDto]
+    # @return [Vapi::ServerMessageLanguageChangedPhoneNumber]
+    def self.vapi(member:)
+      new(member: member, discriminant: "vapi")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/server_message_message.rb

@@ -0,0 +1,285 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "server_message_assistant_request"
+require_relative "server_message_conversation_update"
+require_relative "server_message_end_of_call_report"
+require_relative "server_message_hang"
+require_relative "server_message_model_output"
+require_relative "server_message_phone_call_control"
+require_relative "server_message_speech_update"
+require_relative "server_message_status_update"
+require_relative "server_message_tool_calls"
+require_relative "server_message_transfer_destination_request"
+require_relative "server_message_transfer_update"
+require_relative "server_message_transcript"
+require_relative "server_message_user_interrupted"
+require_relative "server_message_language_changed"
+require_relative "server_message_voice_input"
+require_relative "server_message_voice_request"
+
+module Vapi
+  # These are all the messages that can be sent to your server before, after and
+  #  during the call. Configure the messages you'd like to receive in
+  #  `assistant.serverMessages`.
+  #  The server where the message is sent is determined by the following precedence
+  #  order:
+  #  1. `tool.server.url` (if configured, and only for "tool-calls" message)
+  #  2. `assistant.serverUrl` (if configure)
+  #  3. `phoneNumber.serverUrl` (if configured)
+  #  4. `org.serverUrl` (if configured)
+  class ServerMessageMessage
+    # @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::ServerMessageMessage]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of ServerMessageMessage
+    #
+    # @param json_object [String]
+    # @return [Vapi::ServerMessageMessage]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "assistant-request"
+                 Vapi::ServerMessageAssistantRequest.from_json(json_object: json_object)
+               when "conversation-update"
+                 Vapi::ServerMessageConversationUpdate.from_json(json_object: json_object)
+               when "end-of-call-report"
+                 Vapi::ServerMessageEndOfCallReport.from_json(json_object: json_object)
+               when "hang"
+                 Vapi::ServerMessageHang.from_json(json_object: json_object)
+               when "model-output"
+                 Vapi::ServerMessageModelOutput.from_json(json_object: json_object)
+               when "phone-call-control"
+                 Vapi::ServerMessagePhoneCallControl.from_json(json_object: json_object)
+               when "speech-update"
+                 Vapi::ServerMessageSpeechUpdate.from_json(json_object: json_object)
+               when "status-update"
+                 Vapi::ServerMessageStatusUpdate.from_json(json_object: json_object)
+               when "tool-calls"
+                 Vapi::ServerMessageToolCalls.from_json(json_object: json_object)
+               when "transfer-destination-request"
+                 Vapi::ServerMessageTransferDestinationRequest.from_json(json_object: json_object)
+               when "transfer-update"
+                 Vapi::ServerMessageTransferUpdate.from_json(json_object: json_object)
+               when "transcript"
+                 Vapi::ServerMessageTranscript.from_json(json_object: json_object)
+               when "user-interrupted"
+                 Vapi::ServerMessageUserInterrupted.from_json(json_object: json_object)
+               when "language-changed"
+                 Vapi::ServerMessageLanguageChanged.from_json(json_object: json_object)
+               when "voice-input"
+                 Vapi::ServerMessageVoiceInput.from_json(json_object: json_object)
+               when "voice-request"
+                 Vapi::ServerMessageVoiceRequest.from_json(json_object: json_object)
+               else
+                 Vapi::ServerMessageAssistantRequest.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 "assistant-request"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "conversation-update"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "end-of-call-report"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "hang"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "model-output"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "phone-call-control"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "speech-update"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "status-update"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "tool-calls"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "transfer-destination-request"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "transfer-update"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "transcript"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "user-interrupted"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "language-changed"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "voice-input"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "voice-request"
+        { **@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 "assistant-request"
+        Vapi::ServerMessageAssistantRequest.validate_raw(obj: obj)
+      when "conversation-update"
+        Vapi::ServerMessageConversationUpdate.validate_raw(obj: obj)
+      when "end-of-call-report"
+        Vapi::ServerMessageEndOfCallReport.validate_raw(obj: obj)
+      when "hang"
+        Vapi::ServerMessageHang.validate_raw(obj: obj)
+      when "model-output"
+        Vapi::ServerMessageModelOutput.validate_raw(obj: obj)
+      when "phone-call-control"
+        Vapi::ServerMessagePhoneCallControl.validate_raw(obj: obj)
+      when "speech-update"
+        Vapi::ServerMessageSpeechUpdate.validate_raw(obj: obj)
+      when "status-update"
+        Vapi::ServerMessageStatusUpdate.validate_raw(obj: obj)
+      when "tool-calls"
+        Vapi::ServerMessageToolCalls.validate_raw(obj: obj)
+      when "transfer-destination-request"
+        Vapi::ServerMessageTransferDestinationRequest.validate_raw(obj: obj)
+      when "transfer-update"
+        Vapi::ServerMessageTransferUpdate.validate_raw(obj: obj)
+      when "transcript"
+        Vapi::ServerMessageTranscript.validate_raw(obj: obj)
+      when "user-interrupted"
+        Vapi::ServerMessageUserInterrupted.validate_raw(obj: obj)
+      when "language-changed"
+        Vapi::ServerMessageLanguageChanged.validate_raw(obj: obj)
+      when "voice-input"
+        Vapi::ServerMessageVoiceInput.validate_raw(obj: obj)
+      when "voice-request"
+        Vapi::ServerMessageVoiceRequest.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::ServerMessageAssistantRequest]
+    # @return [Vapi::ServerMessageMessage]
+    def self.assistant_request(member:)
+      new(member: member, discriminant: "assistant-request")
+    end
+
+    # @param member [Vapi::ServerMessageConversationUpdate]
+    # @return [Vapi::ServerMessageMessage]
+    def self.conversation_update(member:)
+      new(member: member, discriminant: "conversation-update")
+    end
+
+    # @param member [Vapi::ServerMessageEndOfCallReport]
+    # @return [Vapi::ServerMessageMessage]
+    def self.end_of_call_report(member:)
+      new(member: member, discriminant: "end-of-call-report")
+    end
+
+    # @param member [Vapi::ServerMessageHang]
+    # @return [Vapi::ServerMessageMessage]
+    def self.hang(member:)
+      new(member: member, discriminant: "hang")
+    end
+
+    # @param member [Vapi::ServerMessageModelOutput]
+    # @return [Vapi::ServerMessageMessage]
+    def self.model_output(member:)
+      new(member: member, discriminant: "model-output")
+    end
+
+    # @param member [Vapi::ServerMessagePhoneCallControl]
+    # @return [Vapi::ServerMessageMessage]
+    def self.phone_call_control(member:)
+      new(member: member, discriminant: "phone-call-control")
+    end
+
+    # @param member [Vapi::ServerMessageSpeechUpdate]
+    # @return [Vapi::ServerMessageMessage]
+    def self.speech_update(member:)
+      new(member: member, discriminant: "speech-update")
+    end
+
+    # @param member [Vapi::ServerMessageStatusUpdate]
+    # @return [Vapi::ServerMessageMessage]
+    def self.status_update(member:)
+      new(member: member, discriminant: "status-update")
+    end
+
+    # @param member [Vapi::ServerMessageToolCalls]
+    # @return [Vapi::ServerMessageMessage]
+    def self.tool_calls(member:)
+      new(member: member, discriminant: "tool-calls")
+    end
+
+    # @param member [Vapi::ServerMessageTransferDestinationRequest]
+    # @return [Vapi::ServerMessageMessage]
+    def self.transfer_destination_request(member:)
+      new(member: member, discriminant: "transfer-destination-request")
+    end
+
+    # @param member [Vapi::ServerMessageTransferUpdate]
+    # @return [Vapi::ServerMessageMessage]
+    def self.transfer_update(member:)
+      new(member: member, discriminant: "transfer-update")
+    end
+
+    # @param member [Vapi::ServerMessageTranscript]
+    # @return [Vapi::ServerMessageMessage]
+    def self.transcript(member:)
+      new(member: member, discriminant: "transcript")
+    end
+
+    # @param member [Vapi::ServerMessageUserInterrupted]
+    # @return [Vapi::ServerMessageMessage]
+    def self.user_interrupted(member:)
+      new(member: member, discriminant: "user-interrupted")
+    end
+
+    # @param member [Vapi::ServerMessageLanguageChanged]
+    # @return [Vapi::ServerMessageMessage]
+    def self.language_changed(member:)
+      new(member: member, discriminant: "language-changed")
+    end
+
+    # @param member [Vapi::ServerMessageVoiceInput]
+    # @return [Vapi::ServerMessageMessage]
+    def self.voice_input(member:)
+      new(member: member, discriminant: "voice-input")
+    end
+
+    # @param member [Vapi::ServerMessageVoiceRequest]
+    # @return [Vapi::ServerMessageMessage]
+    def self.voice_request(member:)
+      new(member: member, discriminant: "voice-request")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/server_message_model_output.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+require_relative "server_message_model_output_phone_number"
+require_relative "artifact"
+require_relative "create_assistant_dto"
+require_relative "create_customer_dto"
+require_relative "call"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ServerMessageModelOutput
+    # @return [Vapi::ServerMessageModelOutputPhoneNumber] This is the phone number associated with the call.
+    #  This matches one of the following:
+    #  - `call.phoneNumber`,
+    #  - `call.phoneNumberId`.
+    attr_reader :phone_number
+    # @return [String] This is the ISO-8601 formatted timestamp of when the message was sent.
+    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`.
+    attr_reader :assistant
+    # @return [Vapi::CreateCustomerDto] This is the customer associated with the call.
+    #  This matches one of the following:
+    #  - `call.customer`,
+    #  - `call.customerId`.
+    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.
+    attr_reader :call
+    # @return [Hash{String => Object}] This is the output of the model. It can be a token or tool call.
+    attr_reader :output
+    # @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 phone_number [Vapi::ServerMessageModelOutputPhoneNumber] This is the phone number associated with the call.
+    #  This matches one of the following:
+    #  - `call.phoneNumber`,
+    #  - `call.phoneNumberId`.
+    # @param timestamp [String] This is the ISO-8601 formatted timestamp of when the message was sent.
+    # @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 output [Hash{String => Object}] This is the output of the model. It can be a token or tool call.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ServerMessageModelOutput]
+    def initialize(output:, phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT,
+                   call: OMIT, additional_properties: nil)
+      @phone_number = phone_number if phone_number != 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
+      @output = output
+      @additional_properties = additional_properties
+      @_field_set = {
+        "phoneNumber": phone_number,
+        "timestamp": timestamp,
+        "artifact": artifact,
+        "assistant": assistant,
+        "customer": customer,
+        "call": call,
+        "output": output
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ServerMessageModelOutput
+    #
+    # @param json_object [String]
+    # @return [Vapi::ServerMessageModelOutput]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["phoneNumber"].nil?
+        phone_number = nil
+      else
+        phone_number = parsed_json["phoneNumber"].to_json
+        phone_number = Vapi::ServerMessageModelOutputPhoneNumber.from_json(json_object: phone_number)
+      end
+      timestamp = parsed_json["timestamp"]
+      if parsed_json["artifact"].nil?
+        artifact = nil
+      else
+        artifact = parsed_json["artifact"].to_json
+        artifact = Vapi::Artifact.from_json(json_object: artifact)
+      end
+      if parsed_json["assistant"].nil?
+        assistant = nil
+      else
+        assistant = parsed_json["assistant"].to_json
+        assistant = Vapi::CreateAssistantDto.from_json(json_object: assistant)
+      end
+      if parsed_json["customer"].nil?
+        customer = nil
+      else
+        customer = parsed_json["customer"].to_json
+        customer = Vapi::CreateCustomerDto.from_json(json_object: customer)
+      end
+      if parsed_json["call"].nil?
+        call = nil
+      else
+        call = parsed_json["call"].to_json
+        call = Vapi::Call.from_json(json_object: call)
+      end
+      output = parsed_json["output"]
+      new(
+        phone_number: phone_number,
+        timestamp: timestamp,
+        artifact: artifact,
+        assistant: assistant,
+        customer: customer,
+        call: call,
+        output: output,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ServerMessageModelOutput 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.phone_number.nil? || Vapi::ServerMessageModelOutputPhoneNumber.validate_raw(obj: obj.phone_number)
+      obj.timestamp&.is_a?(String) != 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.output.is_a?(Hash) != false || raise("Passed value for field obj.output is not the expected type, validation failed.")
+    end
+  end
+end