vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/server_message_model_output_phone_number.rb

@@ -0,0 +1,124 @@
+# 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 ServerMessageModelOutputPhoneNumber
+    # @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::ServerMessageModelOutputPhoneNumber]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of ServerMessageModelOutputPhoneNumber
+    #
+    # @param json_object [String]
+    # @return [Vapi::ServerMessageModelOutputPhoneNumber]
+    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::ServerMessageModelOutputPhoneNumber]
+    def self.byo_phone_number(member:)
+      new(member: member, discriminant: "byo-phone-number")
+    end
+
+    # @param member [Vapi::CreateTwilioPhoneNumberDto]
+    # @return [Vapi::ServerMessageModelOutputPhoneNumber]
+    def self.twilio(member:)
+      new(member: member, discriminant: "twilio")
+    end
+
+    # @param member [Vapi::CreateVonagePhoneNumberDto]
+    # @return [Vapi::ServerMessageModelOutputPhoneNumber]
+    def self.vonage(member:)
+      new(member: member, discriminant: "vonage")
+    end
+
+    # @param member [Vapi::CreateVapiPhoneNumberDto]
+    # @return [Vapi::ServerMessageModelOutputPhoneNumber]
+    def self.vapi(member:)
+      new(member: member, discriminant: "vapi")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/server_message_phone_call_control.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require_relative "server_message_phone_call_control_phone_number"
+require_relative "server_message_phone_call_control_request"
+require_relative "server_message_phone_call_control_destination"
+require_relative "artifact"
+require_relative "create_assistant_dto"
+require_relative "create_customer_dto"
+require_relative "call"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ServerMessagePhoneCallControl
+    # @return [Vapi::ServerMessagePhoneCallControlPhoneNumber] This is the phone number associated with the call.
+    #  This matches one of the following:
+    #  - `call.phoneNumber`,
+    #  - `call.phoneNumberId`.
+    attr_reader :phone_number
+    # @return [Vapi::ServerMessagePhoneCallControlRequest] This is the request to control the phone call.
+    attr_reader :request
+    # @return [Vapi::ServerMessagePhoneCallControlDestination] This is the destination to forward the call to if the request is "forward".
+    attr_reader :destination
+    # @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 [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::ServerMessagePhoneCallControlPhoneNumber] This is the phone number associated with the call.
+    #  This matches one of the following:
+    #  - `call.phoneNumber`,
+    #  - `call.phoneNumberId`.
+    # @param request [Vapi::ServerMessagePhoneCallControlRequest] This is the request to control the phone call.
+    # @param destination [Vapi::ServerMessagePhoneCallControlDestination] This is the destination to forward the call to if the request is "forward".
+    # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ServerMessagePhoneCallControl]
+    def initialize(request:, phone_number: OMIT, destination: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT,
+                   customer: OMIT, call: OMIT, additional_properties: nil)
+      @phone_number = phone_number if phone_number != OMIT
+      @request = request
+      @destination = destination if destination != 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
+      @additional_properties = additional_properties
+      @_field_set = {
+        "phoneNumber": phone_number,
+        "request": request,
+        "destination": destination,
+        "timestamp": timestamp,
+        "artifact": artifact,
+        "assistant": assistant,
+        "customer": customer,
+        "call": call
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ServerMessagePhoneCallControl
+    #
+    # @param json_object [String]
+    # @return [Vapi::ServerMessagePhoneCallControl]
+    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::ServerMessagePhoneCallControlPhoneNumber.from_json(json_object: phone_number)
+      end
+      request = parsed_json["request"]
+      if parsed_json["destination"].nil?
+        destination = nil
+      else
+        destination = parsed_json["destination"].to_json
+        destination = Vapi::ServerMessagePhoneCallControlDestination.from_json(json_object: destination)
+      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
+      new(
+        phone_number: phone_number,
+        request: request,
+        destination: destination,
+        timestamp: timestamp,
+        artifact: artifact,
+        assistant: assistant,
+        customer: customer,
+        call: call,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ServerMessagePhoneCallControl 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::ServerMessagePhoneCallControlPhoneNumber.validate_raw(obj: obj.phone_number)
+      obj.request.is_a?(Vapi::ServerMessagePhoneCallControlRequest) != false || raise("Passed value for field obj.request is not the expected type, validation failed.")
+      obj.destination.nil? || Vapi::ServerMessagePhoneCallControlDestination.validate_raw(obj: obj.destination)
+      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)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/server_message_phone_call_control_destination.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "transfer_destination_number"
+require_relative "transfer_destination_sip"
+
+module Vapi
+  # This is the destination to forward the call to if the request is "forward".
+  class ServerMessagePhoneCallControlDestination
+    # @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::ServerMessagePhoneCallControlDestination]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  ServerMessagePhoneCallControlDestination
+    #
+    # @param json_object [String]
+    # @return [Vapi::ServerMessagePhoneCallControlDestination]
+    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::ServerMessagePhoneCallControlDestination]
+    def self.number(member:)
+      new(member: member, discriminant: "number")
+    end
+
+    # @param member [Vapi::TransferDestinationSip]
+    # @return [Vapi::ServerMessagePhoneCallControlDestination]
+    def self.sip(member:)
+      new(member: member, discriminant: "sip")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/server_message_phone_call_control_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 ServerMessagePhoneCallControlPhoneNumber
+    # @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::ServerMessagePhoneCallControlPhoneNumber]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  ServerMessagePhoneCallControlPhoneNumber
+    #
+    # @param json_object [String]
+    # @return [Vapi::ServerMessagePhoneCallControlPhoneNumber]
+    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::ServerMessagePhoneCallControlPhoneNumber]
+    def self.byo_phone_number(member:)
+      new(member: member, discriminant: "byo-phone-number")
+    end
+
+    # @param member [Vapi::CreateTwilioPhoneNumberDto]
+    # @return [Vapi::ServerMessagePhoneCallControlPhoneNumber]
+    def self.twilio(member:)
+      new(member: member, discriminant: "twilio")
+    end
+
+    # @param member [Vapi::CreateVonagePhoneNumberDto]
+    # @return [Vapi::ServerMessagePhoneCallControlPhoneNumber]
+    def self.vonage(member:)
+      new(member: member, discriminant: "vonage")
+    end
+
+    # @param member [Vapi::CreateVapiPhoneNumberDto]
+    # @return [Vapi::ServerMessagePhoneCallControlPhoneNumber]
+    def self.vapi(member:)
+      new(member: member, discriminant: "vapi")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/server_message_phone_call_control_request.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the request to control the phone call.
+  class ServerMessagePhoneCallControlRequest
+    FORWARD = "forward"
+    HANG_UP = "hang-up"
+  end
+end

data/lib/vapi_server_sdk/types/server_message_response.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "server_message_response_message_response"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ServerMessageResponse
+    # @return [Vapi::ServerMessageResponseMessageResponse] This is the response that is expected from the server to the message.
+    #  Note: Most messages don't expect a response. Only "assistant-request",
+    #  "tool-calls" and "transfer-destination-request" do.
+    attr_reader :message_response
+    # @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_response [Vapi::ServerMessageResponseMessageResponse] This is the response that is expected from the server to the message.
+    #  Note: Most messages don't expect a response. Only "assistant-request",
+    #  "tool-calls" and "transfer-destination-request" do.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ServerMessageResponse]
+    def initialize(message_response:, additional_properties: nil)
+      @message_response = message_response
+      @additional_properties = additional_properties
+      @_field_set = { "messageResponse": message_response }
+    end
+
+    # Deserialize a JSON object to an instance of ServerMessageResponse
+    #
+    # @param json_object [String]
+    # @return [Vapi::ServerMessageResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["messageResponse"].nil?
+        message_response = nil
+      else
+        message_response = parsed_json["messageResponse"].to_json
+        message_response = Vapi::ServerMessageResponseMessageResponse.from_json(json_object: message_response)
+      end
+      new(message_response: message_response, additional_properties: struct)
+    end
+
+    # Serialize an instance of ServerMessageResponse 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::ServerMessageResponseMessageResponse.validate_raw(obj: obj.message_response)
+    end
+  end
+end