vapi_server_sdk 0.1.0 → 0.2.0

data/lib/vapi_server_sdk/types/cartesia_credential.rb

@@ -18,6 +18,8 @@ module Vapi
     attr_reader :created_at
     # @return [DateTime] This is the ISO 8601 date-time string of when the assistant was last updated.
     attr_reader :updated_at
+    # @return [String] This is the name of credential. This is just for your reference.
+    attr_reader :name
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -32,15 +34,17 @@ module Vapi
     # @param org_id [String] This is the unique identifier for the org that this credential belongs to.
     # @param created_at [DateTime] This is the ISO 8601 date-time string of when the credential was created.
     # @param updated_at [DateTime] This is the ISO 8601 date-time string of when the assistant was last updated.
+    # @param name [String] This is the name of credential. This is just for your reference.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::CartesiaCredential]
-    def initialize(provider:, api_key:, id:, org_id:, created_at:, updated_at:, additional_properties: nil)
+    def initialize(provider:, api_key:, id:, org_id:, created_at:, updated_at:, name: OMIT, additional_properties: nil)
       @provider = provider
       @api_key = api_key
       @id = id
       @org_id = org_id
       @created_at = created_at
       @updated_at = updated_at
+      @name = name if name != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "provider": provider,
@@ -48,8 +52,11 @@ module Vapi
         "id": id,
         "orgId": org_id,
         "createdAt": created_at,
-        "updatedAt": updated_at
-      }
+        "updatedAt": updated_at,
+        "name": name
+      }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of CartesiaCredential
@@ -65,6 +72,7 @@ module Vapi
       org_id = parsed_json["orgId"]
       created_at = (DateTime.parse(parsed_json["createdAt"]) unless parsed_json["createdAt"].nil?)
       updated_at = (DateTime.parse(parsed_json["updatedAt"]) unless parsed_json["updatedAt"].nil?)
+      name = parsed_json["name"]
       new(
         provider: provider,
         api_key: api_key,
@@ -72,6 +80,7 @@ module Vapi
         org_id: org_id,
         created_at: created_at,
         updated_at: updated_at,
+        name: name,
         additional_properties: struct
       )
     end
@@ -96,6 +105,7 @@ module Vapi
       obj.org_id.is_a?(String) != false || raise("Passed value for field obj.org_id is not the expected type, validation failed.")
       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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/cartesia_voice.rb

@@ -3,26 +3,26 @@
 require_relative "cartesia_voice_model"
 require_relative "cartesia_voice_language"
 require_relative "chunk_plan"
+require_relative "fallback_plan"
 require "ostruct"
 require "json"
 
 module Vapi
   class CartesiaVoice
-    # @return [Boolean] This determines whether fillers are injected into the model output before
-    #  inputting it into the voice provider.
-    #  Default `false` because you can achieve better results with prompting the model.
-    attr_reader :filler_injection_enabled
     # @return [Vapi::CartesiaVoiceModel] This is the model that will be used. This is optional and will default to the
     #  correct model for the voiceId.
     attr_reader :model
     # @return [Vapi::CartesiaVoiceLanguage] This is the language that will be used. This is optional and will default to the
     #  correct language for the voiceId.
     attr_reader :language
-    # @return [String] This is the provider-specific ID that will be used.
-    attr_reader :voice_id
     # @return [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
     #  provider.
     attr_reader :chunk_plan
+    # @return [String] This is the provider-specific ID that will be used.
+    attr_reader :voice_id
+    # @return [Vapi::FallbackPlan] This is the plan for voice provider fallbacks in the event that the primary
+    #  voice provider fails.
+    attr_reader :fallback_plan
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -31,32 +31,31 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param filler_injection_enabled [Boolean] This determines whether fillers are injected into the model output before
-    #  inputting it into the voice provider.
-    #  Default `false` because you can achieve better results with prompting the model.
     # @param model [Vapi::CartesiaVoiceModel] This is the model that will be used. This is optional and will default to the
     #  correct model for the voiceId.
     # @param language [Vapi::CartesiaVoiceLanguage] This is the language that will be used. This is optional and will default to the
     #  correct language for the voiceId.
-    # @param voice_id [String] This is the provider-specific ID that will be used.
     # @param chunk_plan [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
     #  provider.
+    # @param voice_id [String] This is the provider-specific ID that will be used.
+    # @param fallback_plan [Vapi::FallbackPlan] This is the plan for voice provider fallbacks in the event that the primary
+    #  voice provider fails.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::CartesiaVoice]
-    def initialize(voice_id:, filler_injection_enabled: OMIT, model: OMIT, language: OMIT, chunk_plan: OMIT,
+    def initialize(voice_id:, model: OMIT, language: OMIT, chunk_plan: OMIT, fallback_plan: OMIT,
                    additional_properties: nil)
-      @filler_injection_enabled = filler_injection_enabled if filler_injection_enabled != OMIT
       @model = model if model != OMIT
       @language = language if language != OMIT
-      @voice_id = voice_id
       @chunk_plan = chunk_plan if chunk_plan != OMIT
+      @voice_id = voice_id
+      @fallback_plan = fallback_plan if fallback_plan != OMIT
       @additional_properties = additional_properties
       @_field_set = {
-        "fillerInjectionEnabled": filler_injection_enabled,
         "model": model,
         "language": language,
+        "chunkPlan": chunk_plan,
         "voiceId": voice_id,
-        "chunkPlan": chunk_plan
+        "fallbackPlan": fallback_plan
       }.reject do |_k, v|
         v == OMIT
       end
@@ -69,22 +68,27 @@ module Vapi
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      filler_injection_enabled = parsed_json["fillerInjectionEnabled"]
       model = parsed_json["model"]
       language = parsed_json["language"]
-      voice_id = parsed_json["voiceId"]
       if parsed_json["chunkPlan"].nil?
         chunk_plan = nil
       else
         chunk_plan = parsed_json["chunkPlan"].to_json
         chunk_plan = Vapi::ChunkPlan.from_json(json_object: chunk_plan)
       end
+      voice_id = parsed_json["voiceId"]
+      if parsed_json["fallbackPlan"].nil?
+        fallback_plan = nil
+      else
+        fallback_plan = parsed_json["fallbackPlan"].to_json
+        fallback_plan = Vapi::FallbackPlan.from_json(json_object: fallback_plan)
+      end
       new(
-        filler_injection_enabled: filler_injection_enabled,
         model: model,
         language: language,
-        voice_id: voice_id,
         chunk_plan: chunk_plan,
+        voice_id: voice_id,
+        fallback_plan: fallback_plan,
         additional_properties: struct
       )
     end
@@ -103,11 +107,11 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.filler_injection_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.filler_injection_enabled is not the expected type, validation failed.")
       obj.model&.is_a?(Vapi::CartesiaVoiceModel) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
       obj.language&.is_a?(Vapi::CartesiaVoiceLanguage) != false || raise("Passed value for field obj.language is not the expected type, validation failed.")
-      obj.voice_id.is_a?(String) != false || raise("Passed value for field obj.voice_id is not the expected type, validation failed.")
       obj.chunk_plan.nil? || Vapi::ChunkPlan.validate_raw(obj: obj.chunk_plan)
+      obj.voice_id.is_a?(String) != false || raise("Passed value for field obj.voice_id is not the expected type, validation failed.")
+      obj.fallback_plan.nil? || Vapi::FallbackPlan.validate_raw(obj: obj.fallback_plan)
     end
   end
 end

data/lib/vapi_server_sdk/types/cartesia_voice_language.rb

@@ -4,12 +4,20 @@ module Vapi
   # This is the language that will be used. This is optional and will default to the
   #  correct language for the voiceId.
   class CartesiaVoiceLanguage
-    DE = "de"
     EN = "en"
+    DE = "de"
     ES = "es"
     FR = "fr"
     JA = "ja"
     PT = "pt"
     ZH = "zh"
+    HI = "hi"
+    IT = "it"
+    KO = "ko"
+    NL = "nl"
+    PL = "pl"
+    RU = "ru"
+    SV = "sv"
+    TR = "tr"
   end
 end

data/lib/vapi_server_sdk/types/client_inbound_message_add_message.rb

@@ -8,6 +8,13 @@ module Vapi
   class ClientInboundMessageAddMessage
     # @return [Vapi::OpenAiMessage] This is the message to add to the conversation.
     attr_reader :message
+    # @return [Boolean] This is the flag to trigger a response, or to insert the message into the
+    #  conversation history silently. Defaults to `true`.
+    #  Usage:
+    #  - Use `true` to trigger a response.
+    #  - Use `false` to insert the message into the conversation history silently.
+    #  @default true
+    attr_reader :trigger_response_enabled
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -17,12 +24,21 @@ module Vapi
     OMIT = Object.new
 
     # @param message [Vapi::OpenAiMessage] This is the message to add to the conversation.
+    # @param trigger_response_enabled [Boolean] This is the flag to trigger a response, or to insert the message into the
+    #  conversation history silently. Defaults to `true`.
+    #  Usage:
+    #  - Use `true` to trigger a response.
+    #  - Use `false` to insert the message into the conversation history silently.
+    #  @default true
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ClientInboundMessageAddMessage]
-    def initialize(message:, additional_properties: nil)
+    def initialize(message:, trigger_response_enabled: OMIT, additional_properties: nil)
       @message = message
+      @trigger_response_enabled = trigger_response_enabled if trigger_response_enabled != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "message": message }
+      @_field_set = { "message": message, "triggerResponseEnabled": trigger_response_enabled }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of ClientInboundMessageAddMessage
@@ -38,7 +54,12 @@ module Vapi
         message = parsed_json["message"].to_json
         message = Vapi::OpenAiMessage.from_json(json_object: message)
       end
-      new(message: message, additional_properties: struct)
+      trigger_response_enabled = parsed_json["triggerResponseEnabled"]
+      new(
+        message: message,
+        trigger_response_enabled: trigger_response_enabled,
+        additional_properties: struct
+      )
     end
 
     # Serialize an instance of ClientInboundMessageAddMessage to a JSON object
@@ -56,6 +77,7 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       Vapi::OpenAiMessage.validate_raw(obj: obj.message)
+      obj.trigger_response_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.trigger_response_enabled is not the expected type, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/client_inbound_message_message.rb

@@ -4,6 +4,7 @@ require "json"
 require_relative "client_inbound_message_add_message"
 require_relative "client_inbound_message_control"
 require_relative "client_inbound_message_say"
+require_relative "client_inbound_message_transfer"
 
 module Vapi
   # These are the messages that can be sent from client-side SDKs to control the
@@ -38,6 +39,8 @@ module Vapi
                  Vapi::ClientInboundMessageControl.from_json(json_object: json_object)
                when "say"
                  Vapi::ClientInboundMessageSay.from_json(json_object: json_object)
+               when "transfer"
+                 Vapi::ClientInboundMessageTransfer.from_json(json_object: json_object)
                else
                  Vapi::ClientInboundMessageAddMessage.from_json(json_object: json_object)
                end
@@ -55,6 +58,8 @@ module Vapi
         { **@member.to_json, type: @discriminant }.to_json
       when "say"
         { **@member.to_json, type: @discriminant }.to_json
+      when "transfer"
+        { **@member.to_json, type: @discriminant }.to_json
       else
         { "type": @discriminant, value: @member }.to_json
       end
@@ -75,6 +80,8 @@ module Vapi
         Vapi::ClientInboundMessageControl.validate_raw(obj: obj)
       when "say"
         Vapi::ClientInboundMessageSay.validate_raw(obj: obj)
+      when "transfer"
+        Vapi::ClientInboundMessageTransfer.validate_raw(obj: obj)
       else
         raise("Passed value matched no type within the union, validation failed.")
       end
@@ -105,5 +112,11 @@ module Vapi
     def self.say(member:)
       new(member: member, discriminant: "say")
     end
+
+    # @param member [Vapi::ClientInboundMessageTransfer]
+    # @return [Vapi::ClientInboundMessageMessage]
+    def self.transfer(member:)
+      new(member: member, discriminant: "transfer")
+    end
   end
 end

data/lib/vapi_server_sdk/types/client_inbound_message_transfer.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative "client_inbound_message_transfer_destination"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ClientInboundMessageTransfer
+    # @return [Vapi::ClientInboundMessageTransferDestination] This is the destination to transfer the call to.
+    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::ClientInboundMessageTransferDestination] This is the destination to transfer the call to.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ClientInboundMessageTransfer]
+    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 ClientInboundMessageTransfer
+    #
+    # @param json_object [String]
+    # @return [Vapi::ClientInboundMessageTransfer]
+    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::ClientInboundMessageTransferDestination.from_json(json_object: destination)
+      end
+      new(destination: destination, additional_properties: struct)
+    end
+
+    # Serialize an instance of ClientInboundMessageTransfer 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::ClientInboundMessageTransferDestination.validate_raw(obj: obj.destination)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/client_inbound_message_transfer_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 transfer the call to.
+  class ClientInboundMessageTransferDestination
+    # @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::ClientInboundMessageTransferDestination]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  ClientInboundMessageTransferDestination
+    #
+    # @param json_object [String]
+    # @return [Vapi::ClientInboundMessageTransferDestination]
+    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::ClientInboundMessageTransferDestination]
+    def self.number(member:)
+      new(member: member, discriminant: "number")
+    end
+
+    # @param member [Vapi::TransferDestinationSip]
+    # @return [Vapi::ClientInboundMessageTransferDestination]
+    def self.sip(member:)
+      new(member: member, discriminant: "sip")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/{client_message_language_changed.rb → client_message_language_change_detected.rb}

@@ -4,7 +4,7 @@ require "ostruct"
 require "json"
 
 module Vapi
-  class ClientMessageLanguageChanged
+  class ClientMessageLanguageChangeDetected
     # @return [String] This is the language the transcriber is switched to.
     attr_reader :language
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -17,17 +17,17 @@ module Vapi
 
     # @param language [String] This is the language the transcriber is switched to.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Vapi::ClientMessageLanguageChanged]
+    # @return [Vapi::ClientMessageLanguageChangeDetected]
     def initialize(language:, additional_properties: nil)
       @language = language
       @additional_properties = additional_properties
       @_field_set = { "language": language }
     end
 
-    # Deserialize a JSON object to an instance of ClientMessageLanguageChanged
+    # Deserialize a JSON object to an instance of ClientMessageLanguageChangeDetected
     #
     # @param json_object [String]
-    # @return [Vapi::ClientMessageLanguageChanged]
+    # @return [Vapi::ClientMessageLanguageChangeDetected]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
@@ -35,7 +35,7 @@ module Vapi
       new(language: language, additional_properties: struct)
     end
 
-    # Serialize an instance of ClientMessageLanguageChanged to a JSON object
+    # Serialize an instance of ClientMessageLanguageChangeDetected to a JSON object
     #
     # @return [String]
     def to_json(*_args)

data/lib/vapi_server_sdk/types/client_message_message.rb

@@ -9,8 +9,9 @@ require_relative "client_message_speech_update"
 require_relative "client_message_transcript"
 require_relative "client_message_tool_calls"
 require_relative "client_message_tool_calls_result"
+require_relative "client_message_transfer_update"
 require_relative "client_message_user_interrupted"
-require_relative "client_message_language_changed"
+require_relative "client_message_language_change_detected"
 require_relative "client_message_voice_input"
 
 module Vapi
@@ -57,10 +58,12 @@ module Vapi
                  Vapi::ClientMessageToolCalls.from_json(json_object: json_object)
                when "tool-calls-result"
                  Vapi::ClientMessageToolCallsResult.from_json(json_object: json_object)
+               when "transfer-update"
+                 Vapi::ClientMessageTransferUpdate.from_json(json_object: json_object)
                when "user-interrupted"
                  Vapi::ClientMessageUserInterrupted.from_json(json_object: json_object)
-               when "language-changed"
-                 Vapi::ClientMessageLanguageChanged.from_json(json_object: json_object)
+               when "language-change-detected"
+                 Vapi::ClientMessageLanguageChangeDetected.from_json(json_object: json_object)
                when "voice-input"
                  Vapi::ClientMessageVoiceInput.from_json(json_object: json_object)
                else
@@ -90,9 +93,11 @@ module Vapi
         { **@member.to_json, type: @discriminant }.to_json
       when "tool-calls-result"
         { **@member.to_json, type: @discriminant }.to_json
+      when "transfer-update"
+        { **@member.to_json, type: @discriminant }.to_json
       when "user-interrupted"
         { **@member.to_json, type: @discriminant }.to_json
-      when "language-changed"
+      when "language-change-detected"
         { **@member.to_json, type: @discriminant }.to_json
       when "voice-input"
         { **@member.to_json, type: @discriminant }.to_json
@@ -126,10 +131,12 @@ module Vapi
         Vapi::ClientMessageToolCalls.validate_raw(obj: obj)
       when "tool-calls-result"
         Vapi::ClientMessageToolCallsResult.validate_raw(obj: obj)
+      when "transfer-update"
+        Vapi::ClientMessageTransferUpdate.validate_raw(obj: obj)
       when "user-interrupted"
         Vapi::ClientMessageUserInterrupted.validate_raw(obj: obj)
-      when "language-changed"
-        Vapi::ClientMessageLanguageChanged.validate_raw(obj: obj)
+      when "language-change-detected"
+        Vapi::ClientMessageLanguageChangeDetected.validate_raw(obj: obj)
       when "voice-input"
         Vapi::ClientMessageVoiceInput.validate_raw(obj: obj)
       else
@@ -193,16 +200,22 @@ module Vapi
       new(member: member, discriminant: "tool-calls-result")
     end
 
+    # @param member [Vapi::ClientMessageTransferUpdate]
+    # @return [Vapi::ClientMessageMessage]
+    def self.transfer_update(member:)
+      new(member: member, discriminant: "transfer-update")
+    end
+
     # @param member [Vapi::ClientMessageUserInterrupted]
     # @return [Vapi::ClientMessageMessage]
     def self.user_interrupted(member:)
       new(member: member, discriminant: "user-interrupted")
     end
 
-    # @param member [Vapi::ClientMessageLanguageChanged]
+    # @param member [Vapi::ClientMessageLanguageChangeDetected]
     # @return [Vapi::ClientMessageMessage]
-    def self.language_changed(member:)
-      new(member: member, discriminant: "language-changed")
+    def self.language_change_detected(member:)
+      new(member: member, discriminant: "language-change-detected")
     end
 
     # @param member [Vapi::ClientMessageVoiceInput]