vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/fallback_neets_voice.rb

@@ -1,17 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "fallback_neets_voice_id"
-require_relative "chunk_plan"
 require "ostruct"
 require "json"
 
 module Vapi
   class FallbackNeetsVoice
-    # @return [Vapi::FallbackNeetsVoiceId] This is the provider-specific ID that will be used.
+    # @return [Object]
     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 [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -20,16 +15,13 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param voice_id [Vapi::FallbackNeetsVoiceId] 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 [Object]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::FallbackNeetsVoice]
-    def initialize(voice_id:, chunk_plan: OMIT, additional_properties: nil)
-      @voice_id = voice_id
-      @chunk_plan = chunk_plan if chunk_plan != OMIT
+    def initialize(voice_id: OMIT, additional_properties: nil)
+      @voice_id = voice_id if voice_id != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "voiceId": voice_id, "chunkPlan": chunk_plan }.reject do |_k, v|
+      @_field_set = { "voiceId": voice_id }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -41,23 +33,8 @@ module Vapi
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      if parsed_json["voiceId"].nil?
-        voice_id = nil
-      else
-        voice_id = parsed_json["voiceId"].to_json
-        voice_id = Vapi::FallbackNeetsVoiceId.from_json(json_object: voice_id)
-      end
-      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
-      new(
-        voice_id: voice_id,
-        chunk_plan: chunk_plan,
-        additional_properties: struct
-      )
+      voice_id = parsed_json["voiceId"]
+      new(voice_id: voice_id, additional_properties: struct)
     end
 
     # Serialize an instance of FallbackNeetsVoice to a JSON object
@@ -74,8 +51,7 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      Vapi::FallbackNeetsVoiceId.validate_raw(obj: obj.voice_id)
-      obj.chunk_plan.nil? || Vapi::ChunkPlan.validate_raw(obj: obj.chunk_plan)
+      obj.voice_id&.is_a?(Object) != false || raise("Passed value for field obj.voice_id is not the expected type, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/fallback_neuphonic_voice.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require_relative "fallback_neuphonic_voice_model"
+require_relative "chunk_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class FallbackNeuphonicVoice
+    # @return [Boolean] This is the flag to toggle voice caching for the assistant.
+    attr_reader :caching_enabled
+    # @return [String] This is the provider-specific ID that will be used.
+    attr_reader :voice_id
+    # @return [Vapi::FallbackNeuphonicVoiceModel] This is the model that will be used. Defaults to 'neu_fast' if not specified.
+    attr_reader :model
+    # @return [Hash{String => Object}] This is the language (ISO 639-1) that is enforced for the model.
+    attr_reader :language
+    # @return [Float] This is the speed multiplier that will be used.
+    attr_reader :speed
+    # @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 [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 caching_enabled [Boolean] This is the flag to toggle voice caching for the assistant.
+    # @param voice_id [String] This is the provider-specific ID that will be used.
+    # @param model [Vapi::FallbackNeuphonicVoiceModel] This is the model that will be used. Defaults to 'neu_fast' if not specified.
+    # @param language [Hash{String => Object}] This is the language (ISO 639-1) that is enforced for the model.
+    # @param speed [Float] This is the speed multiplier 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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::FallbackNeuphonicVoice]
+    def initialize(voice_id:, language:, caching_enabled: OMIT, model: OMIT, speed: OMIT, chunk_plan: OMIT,
+                   additional_properties: nil)
+      @caching_enabled = caching_enabled if caching_enabled != OMIT
+      @voice_id = voice_id
+      @model = model if model != OMIT
+      @language = language
+      @speed = speed if speed != OMIT
+      @chunk_plan = chunk_plan if chunk_plan != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "cachingEnabled": caching_enabled,
+        "voiceId": voice_id,
+        "model": model,
+        "language": language,
+        "speed": speed,
+        "chunkPlan": chunk_plan
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of FallbackNeuphonicVoice
+    #
+    # @param json_object [String]
+    # @return [Vapi::FallbackNeuphonicVoice]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      caching_enabled = parsed_json["cachingEnabled"]
+      voice_id = parsed_json["voiceId"]
+      model = parsed_json["model"]
+      language = parsed_json["language"]
+      speed = parsed_json["speed"]
+      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
+      new(
+        caching_enabled: caching_enabled,
+        voice_id: voice_id,
+        model: model,
+        language: language,
+        speed: speed,
+        chunk_plan: chunk_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FallbackNeuphonicVoice 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.caching_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.caching_enabled 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.model&.is_a?(Vapi::FallbackNeuphonicVoiceModel) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
+      obj.language.is_a?(Hash) != false || raise("Passed value for field obj.language is not the expected type, validation failed.")
+      obj.speed&.is_a?(Float) != false || raise("Passed value for field obj.speed is not the expected type, validation failed.")
+      obj.chunk_plan.nil? || Vapi::ChunkPlan.validate_raw(obj: obj.chunk_plan)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/fallback_neuphonic_voice_model.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the model that will be used. Defaults to 'neu_fast' if not specified.
+  class FallbackNeuphonicVoiceModel
+    NEU_HQ = "neu_hq"
+    NEU_FAST = "neu_fast"
+  end
+end

data/lib/vapi_server_sdk/types/fallback_open_ai_transcriber.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative "fallback_open_ai_transcriber_model"
+require_relative "fallback_open_ai_transcriber_language"
+require "ostruct"
+require "json"
+
+module Vapi
+  class FallbackOpenAiTranscriber
+    # @return [Vapi::FallbackOpenAiTranscriberModel] This is the model that will be used for the transcription.
+    attr_reader :model
+    # @return [Vapi::FallbackOpenAiTranscriberLanguage] This is the language that will be set for the transcription.
+    attr_reader :language
+    # @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 model [Vapi::FallbackOpenAiTranscriberModel] This is the model that will be used for the transcription.
+    # @param language [Vapi::FallbackOpenAiTranscriberLanguage] This is the language that will be set for the transcription.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::FallbackOpenAiTranscriber]
+    def initialize(model:, language: OMIT, additional_properties: nil)
+      @model = model
+      @language = language if language != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "model": model, "language": language }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of FallbackOpenAiTranscriber
+    #
+    # @param json_object [String]
+    # @return [Vapi::FallbackOpenAiTranscriber]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      model = parsed_json["model"]
+      language = parsed_json["language"]
+      new(
+        model: model,
+        language: language,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FallbackOpenAiTranscriber 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.model.is_a?(Vapi::FallbackOpenAiTranscriberModel) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
+      obj.language&.is_a?(Vapi::FallbackOpenAiTranscriberLanguage) != false || raise("Passed value for field obj.language is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/fallback_open_ai_transcriber_language.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the language that will be set for the transcription.
+  class FallbackOpenAiTranscriberLanguage
+    AF = "af"
+    AR = "ar"
+    HY = "hy"
+    AZ = "az"
+    BE = "be"
+    BS = "bs"
+    BG = "bg"
+    CA = "ca"
+    ZH = "zh"
+    HR = "hr"
+    CS = "cs"
+    DA = "da"
+    NL = "nl"
+    EN = "en"
+    ET = "et"
+    FI = "fi"
+    FR = "fr"
+    GL = "gl"
+    DE = "de"
+    EL = "el"
+    HE = "he"
+    HI = "hi"
+    HU = "hu"
+    IS = "is"
+    ID = "id"
+    IT = "it"
+    JA = "ja"
+    KN = "kn"
+    KK = "kk"
+    KO = "ko"
+    LV = "lv"
+    LT = "lt"
+    MK = "mk"
+    MS = "ms"
+    MR = "mr"
+    MI = "mi"
+    NE = "ne"
+    NO = "no"
+    FA = "fa"
+    PL = "pl"
+    PT = "pt"
+    RO = "ro"
+    RU = "ru"
+    SR = "sr"
+    SK = "sk"
+    SL = "sl"
+    ES = "es"
+    SW = "sw"
+    SV = "sv"
+    TL = "tl"
+    TA = "ta"
+    TH = "th"
+    TR = "tr"
+    UK = "uk"
+    UR = "ur"
+    VI = "vi"
+    CY = "cy"
+  end
+end

data/lib/vapi_server_sdk/types/fallback_open_ai_transcriber_model.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the model that will be used for the transcription.
+  class FallbackOpenAiTranscriberModel
+    GPT_4_O_TRANSCRIBE = "gpt-4o-transcribe"
+    GPT_4_O_MINI_TRANSCRIBE = "gpt-4o-mini-transcribe"
+  end
+end

data/lib/vapi_server_sdk/types/fallback_open_ai_voice.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 
 require_relative "fallback_open_ai_voice_id"
+require_relative "fallback_open_ai_voice_model"
 require_relative "chunk_plan"
 require "ostruct"
 require "json"
 
 module Vapi
   class FallbackOpenAiVoice
+    # @return [Boolean] This is the flag to toggle voice caching for the assistant.
+    attr_reader :caching_enabled
     # @return [Vapi::FallbackOpenAiVoiceId] This is the provider-specific ID that will be used.
     #  Please note that ash, ballad, coral, sage, and verse may only be used with
     #  realtime models.
     attr_reader :voice_id
+    # @return [Vapi::FallbackOpenAiVoiceModel] This is the model that will be used for text-to-speech.
+    attr_reader :model
+    # @return [String] This is a prompt that allows you to control the voice of your generated audio.
+    #  Does not work with 'tts-1' or 'tts-1-hd' models.
+    attr_reader :instructions
     # @return [Float] This is the speed multiplier that will be used.
     attr_reader :speed
     # @return [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
@@ -24,20 +32,35 @@ module Vapi
 
     OMIT = Object.new
 
+    # @param caching_enabled [Boolean] This is the flag to toggle voice caching for the assistant.
     # @param voice_id [Vapi::FallbackOpenAiVoiceId] This is the provider-specific ID that will be used.
     #  Please note that ash, ballad, coral, sage, and verse may only be used with
     #  realtime models.
+    # @param model [Vapi::FallbackOpenAiVoiceModel] This is the model that will be used for text-to-speech.
+    # @param instructions [String] This is a prompt that allows you to control the voice of your generated audio.
+    #  Does not work with 'tts-1' or 'tts-1-hd' models.
     # @param speed [Float] This is the speed multiplier 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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::FallbackOpenAiVoice]
-    def initialize(voice_id:, speed: OMIT, chunk_plan: OMIT, additional_properties: nil)
+    def initialize(voice_id:, caching_enabled: OMIT, model: OMIT, instructions: OMIT, speed: OMIT, chunk_plan: OMIT,
+                   additional_properties: nil)
+      @caching_enabled = caching_enabled if caching_enabled != OMIT
       @voice_id = voice_id
+      @model = model if model != OMIT
+      @instructions = instructions if instructions != OMIT
       @speed = speed if speed != OMIT
       @chunk_plan = chunk_plan if chunk_plan != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "voiceId": voice_id, "speed": speed, "chunkPlan": chunk_plan }.reject do |_k, v|
+      @_field_set = {
+        "cachingEnabled": caching_enabled,
+        "voiceId": voice_id,
+        "model": model,
+        "instructions": instructions,
+        "speed": speed,
+        "chunkPlan": chunk_plan
+      }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -49,7 +72,15 @@ module Vapi
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      voice_id = parsed_json["voiceId"]
+      caching_enabled = parsed_json["cachingEnabled"]
+      if parsed_json["voiceId"].nil?
+        voice_id = nil
+      else
+        voice_id = parsed_json["voiceId"].to_json
+        voice_id = Vapi::FallbackOpenAiVoiceId.from_json(json_object: voice_id)
+      end
+      model = parsed_json["model"]
+      instructions = parsed_json["instructions"]
       speed = parsed_json["speed"]
       if parsed_json["chunkPlan"].nil?
         chunk_plan = nil
@@ -58,7 +89,10 @@ module Vapi
         chunk_plan = Vapi::ChunkPlan.from_json(json_object: chunk_plan)
       end
       new(
+        caching_enabled: caching_enabled,
         voice_id: voice_id,
+        model: model,
+        instructions: instructions,
         speed: speed,
         chunk_plan: chunk_plan,
         additional_properties: struct
@@ -79,7 +113,10 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.voice_id.is_a?(Vapi::FallbackOpenAiVoiceId) != false || raise("Passed value for field obj.voice_id is not the expected type, validation failed.")
+      obj.caching_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.caching_enabled is not the expected type, validation failed.")
+      Vapi::FallbackOpenAiVoiceId.validate_raw(obj: obj.voice_id)
+      obj.model&.is_a?(Vapi::FallbackOpenAiVoiceModel) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
+      obj.instructions&.is_a?(String) != false || raise("Passed value for field obj.instructions is not the expected type, validation failed.")
       obj.speed&.is_a?(Float) != false || raise("Passed value for field obj.speed is not the expected type, validation failed.")
       obj.chunk_plan.nil? || Vapi::ChunkPlan.validate_raw(obj: obj.chunk_plan)
     end

data/lib/vapi_server_sdk/types/fallback_open_ai_voice_id.rb

@@ -1,20 +1,55 @@
 # frozen_string_literal: true
 
+require "json"
+
 module Vapi
   # This is the provider-specific ID that will be used.
   #  Please note that ash, ballad, coral, sage, and verse may only be used with
   #  realtime models.
   class FallbackOpenAiVoiceId
-    ALLOY = "alloy"
-    ECHO = "echo"
-    FABLE = "fable"
-    ONYX = "onyx"
-    NOVA = "nova"
-    SHIMMER = "shimmer"
-    ASH = "ash"
-    BALLAD = "ballad"
-    CORAL = "coral"
-    SAGE = "sage"
-    VERSE = "verse"
+    # Deserialize a JSON object to an instance of FallbackOpenAiVoiceId
+    #
+    # @param json_object [String]
+    # @return [Vapi::FallbackOpenAiVoiceId]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        struct.is_a?(Vapi::FallbackOpenAiVoiceIdEnum) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+        return struct unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+        return struct unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      struct
+    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:)
+      begin
+        return obj.is_a?(Vapi::FallbackOpenAiVoiceIdEnum) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+      rescue StandardError
+        # noop
+      end
+      begin
+        return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
   end
 end

data/lib/vapi_server_sdk/types/fallback_open_ai_voice_id_enum.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Vapi
+  class FallbackOpenAiVoiceIdEnum
+    ALLOY = "alloy"
+    ECHO = "echo"
+    FABLE = "fable"
+    ONYX = "onyx"
+    NOVA = "nova"
+    SHIMMER = "shimmer"
+  end
+end

data/lib/vapi_server_sdk/types/fallback_open_ai_voice_model.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the model that will be used for text-to-speech.
+  class FallbackOpenAiVoiceModel
+    TTS_1 = "tts-1"
+    TTS_1_HD = "tts-1-hd"
+    GPT_4_O_MINI_TTS = "gpt-4o-mini-tts"
+  end
+end