vapi_server_sdk 0.1.0 → 0.2.0

data/lib/vapi_server_sdk/types/fallback_play_ht_voice.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require_relative "fallback_play_ht_voice_id"
+require_relative "fallback_play_ht_voice_emotion"
+require_relative "fallback_play_ht_voice_model"
+require_relative "fallback_play_ht_voice_language"
+require_relative "chunk_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class FallbackPlayHtVoice
+    # @return [Vapi::FallbackPlayHtVoiceId] This is the provider-specific ID that will be used.
+    attr_reader :voice_id
+    # @return [Float] This is the speed multiplier that will be used.
+    attr_reader :speed
+    # @return [Float] A floating point number between 0, exclusive, and 2, inclusive. If equal to null
+    #  or not provided, the model's default temperature will be used. The temperature
+    #  parameter controls variance. Lower temperatures result in more predictable
+    #  results, higher temperatures allow each run to vary more, so the voice may sound
+    #  less like the baseline voice.
+    attr_reader :temperature
+    # @return [Vapi::FallbackPlayHtVoiceEmotion] An emotion to be applied to the speech.
+    attr_reader :emotion
+    # @return [Float] A number between 1 and 6. Use lower numbers to reduce how unique your chosen
+    #  voice will be compared to other voices.
+    attr_reader :voice_guidance
+    # @return [Float] A number between 1 and 30. Use lower numbers to to reduce how strong your chosen
+    #  emotion will be. Higher numbers will create a very emotional performance.
+    attr_reader :style_guidance
+    # @return [Float] A number between 1 and 2. This number influences how closely the generated
+    #  speech adheres to the input text. Use lower values to create more fluid speech,
+    #  but with a higher chance of deviating from the input text. Higher numbers will
+    #  make the generated speech more accurate to the input text, ensuring that the
+    #  words spoken align closely with the provided text.
+    attr_reader :text_guidance
+    # @return [Vapi::FallbackPlayHtVoiceModel] Playht voice model/engine to use.
+    attr_reader :model
+    # @return [Vapi::FallbackPlayHtVoiceLanguage] The language to use for the speech.
+    attr_reader :language
+    # @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 voice_id [Vapi::FallbackPlayHtVoiceId] This is the provider-specific ID that will be used.
+    # @param speed [Float] This is the speed multiplier that will be used.
+    # @param temperature [Float] A floating point number between 0, exclusive, and 2, inclusive. If equal to null
+    #  or not provided, the model's default temperature will be used. The temperature
+    #  parameter controls variance. Lower temperatures result in more predictable
+    #  results, higher temperatures allow each run to vary more, so the voice may sound
+    #  less like the baseline voice.
+    # @param emotion [Vapi::FallbackPlayHtVoiceEmotion] An emotion to be applied to the speech.
+    # @param voice_guidance [Float] A number between 1 and 6. Use lower numbers to reduce how unique your chosen
+    #  voice will be compared to other voices.
+    # @param style_guidance [Float] A number between 1 and 30. Use lower numbers to to reduce how strong your chosen
+    #  emotion will be. Higher numbers will create a very emotional performance.
+    # @param text_guidance [Float] A number between 1 and 2. This number influences how closely the generated
+    #  speech adheres to the input text. Use lower values to create more fluid speech,
+    #  but with a higher chance of deviating from the input text. Higher numbers will
+    #  make the generated speech more accurate to the input text, ensuring that the
+    #  words spoken align closely with the provided text.
+    # @param model [Vapi::FallbackPlayHtVoiceModel] Playht voice model/engine to use.
+    # @param language [Vapi::FallbackPlayHtVoiceLanguage] The language to use for the speech.
+    # @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::FallbackPlayHtVoice]
+    def initialize(voice_id:, speed: OMIT, temperature: OMIT, emotion: OMIT, voice_guidance: OMIT,
+                   style_guidance: OMIT, text_guidance: OMIT, model: OMIT, language: OMIT, chunk_plan: OMIT, additional_properties: nil)
+      @voice_id = voice_id
+      @speed = speed if speed != OMIT
+      @temperature = temperature if temperature != OMIT
+      @emotion = emotion if emotion != OMIT
+      @voice_guidance = voice_guidance if voice_guidance != OMIT
+      @style_guidance = style_guidance if style_guidance != OMIT
+      @text_guidance = text_guidance if text_guidance != OMIT
+      @model = model if model != OMIT
+      @language = language if language != OMIT
+      @chunk_plan = chunk_plan if chunk_plan != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "voiceId": voice_id,
+        "speed": speed,
+        "temperature": temperature,
+        "emotion": emotion,
+        "voiceGuidance": voice_guidance,
+        "styleGuidance": style_guidance,
+        "textGuidance": text_guidance,
+        "model": model,
+        "language": language,
+        "chunkPlan": chunk_plan
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of FallbackPlayHtVoice
+    #
+    # @param json_object [String]
+    # @return [Vapi::FallbackPlayHtVoice]
+    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::FallbackPlayHtVoiceId.from_json(json_object: voice_id)
+      end
+      speed = parsed_json["speed"]
+      temperature = parsed_json["temperature"]
+      emotion = parsed_json["emotion"]
+      voice_guidance = parsed_json["voiceGuidance"]
+      style_guidance = parsed_json["styleGuidance"]
+      text_guidance = parsed_json["textGuidance"]
+      model = parsed_json["model"]
+      language = parsed_json["language"]
+      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,
+        speed: speed,
+        temperature: temperature,
+        emotion: emotion,
+        voice_guidance: voice_guidance,
+        style_guidance: style_guidance,
+        text_guidance: text_guidance,
+        model: model,
+        language: language,
+        chunk_plan: chunk_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FallbackPlayHtVoice 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::FallbackPlayHtVoiceId.validate_raw(obj: obj.voice_id)
+      obj.speed&.is_a?(Float) != false || raise("Passed value for field obj.speed is not the expected type, validation failed.")
+      obj.temperature&.is_a?(Float) != false || raise("Passed value for field obj.temperature is not the expected type, validation failed.")
+      obj.emotion&.is_a?(Vapi::FallbackPlayHtVoiceEmotion) != false || raise("Passed value for field obj.emotion is not the expected type, validation failed.")
+      obj.voice_guidance&.is_a?(Float) != false || raise("Passed value for field obj.voice_guidance is not the expected type, validation failed.")
+      obj.style_guidance&.is_a?(Float) != false || raise("Passed value for field obj.style_guidance is not the expected type, validation failed.")
+      obj.text_guidance&.is_a?(Float) != false || raise("Passed value for field obj.text_guidance is not the expected type, validation failed.")
+      obj.model&.is_a?(Vapi::FallbackPlayHtVoiceModel) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
+      obj.language&.is_a?(Vapi::FallbackPlayHtVoiceLanguage) != false || raise("Passed value for field obj.language 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_play_ht_voice_emotion.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Vapi
+  # An emotion to be applied to the speech.
+  class FallbackPlayHtVoiceEmotion
+    FEMALE_HAPPY = "female_happy"
+    FEMALE_SAD = "female_sad"
+    FEMALE_ANGRY = "female_angry"
+    FEMALE_FEARFUL = "female_fearful"
+    FEMALE_DISGUST = "female_disgust"
+    FEMALE_SURPRISED = "female_surprised"
+    MALE_HAPPY = "male_happy"
+    MALE_SAD = "male_sad"
+    MALE_ANGRY = "male_angry"
+    MALE_FEARFUL = "male_fearful"
+    MALE_DISGUST = "male_disgust"
+    MALE_SURPRISED = "male_surprised"
+  end
+end

data/lib/vapi_server_sdk/types/fallback_play_ht_voice_id.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vapi
+  # This is the provider-specific ID that will be used.
+  class FallbackPlayHtVoiceId
+    # Deserialize a JSON object to an instance of FallbackPlayHtVoiceId
+    #
+    # @param json_object [String]
+    # @return [Vapi::FallbackPlayHtVoiceId]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        struct.is_a?(Vapi::FallbackPlayHtVoiceIdEnum) != 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::FallbackPlayHtVoiceIdEnum) != 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_play_ht_voice_id_enum.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Vapi
+  class FallbackPlayHtVoiceIdEnum
+    JENNIFER = "jennifer"
+    MELISSA = "melissa"
+    WILL = "will"
+    CHRIS = "chris"
+    MATT = "matt"
+    JACK = "jack"
+    RUBY = "ruby"
+    DAVIS = "davis"
+    DONNA = "donna"
+    MICHAEL = "michael"
+  end
+end

data/lib/vapi_server_sdk/types/fallback_play_ht_voice_language.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Vapi
+  # The language to use for the speech.
+  class FallbackPlayHtVoiceLanguage
+    AFRIKAANS = "afrikaans"
+    ALBANIAN = "albanian"
+    AMHARIC = "amharic"
+    ARABIC = "arabic"
+    BENGALI = "bengali"
+    BULGARIAN = "bulgarian"
+    CATALAN = "catalan"
+    CROATIAN = "croatian"
+    CZECH = "czech"
+    DANISH = "danish"
+    DUTCH = "dutch"
+    ENGLISH = "english"
+    FRENCH = "french"
+    GALICIAN = "galician"
+    GERMAN = "german"
+    GREEK = "greek"
+    HEBREW = "hebrew"
+    HINDI = "hindi"
+    HUNGARIAN = "hungarian"
+    INDONESIAN = "indonesian"
+    ITALIAN = "italian"
+    JAPANESE = "japanese"
+    KOREAN = "korean"
+    MALAY = "malay"
+    MANDARIN = "mandarin"
+    POLISH = "polish"
+    PORTUGUESE = "portuguese"
+    RUSSIAN = "russian"
+    SERBIAN = "serbian"
+    SPANISH = "spanish"
+    SWEDISH = "swedish"
+    TAGALOG = "tagalog"
+    THAI = "thai"
+    TURKISH = "turkish"
+    UKRAINIAN = "ukrainian"
+    URDU = "urdu"
+    XHOSA = "xhosa"
+  end
+end

data/lib/vapi_server_sdk/types/fallback_play_ht_voice_model.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Vapi
+  # Playht voice model/engine to use.
+  class FallbackPlayHtVoiceModel
+    PLAY_HT_20 = "PlayHT2.0"
+    PLAY_HT_20_TURBO = "PlayHT2.0-turbo"
+    PLAY_30_MINI = "Play3.0-mini"
+  end
+end

data/lib/vapi_server_sdk/types/fallback_rime_ai_voice.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative "fallback_rime_ai_voice_id"
+require_relative "fallback_rime_ai_voice_model"
+require_relative "chunk_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class FallbackRimeAiVoice
+    # @return [Vapi::FallbackRimeAiVoiceId] This is the provider-specific ID that will be used.
+    attr_reader :voice_id
+    # @return [Vapi::FallbackRimeAiVoiceModel] This is the model that will be used. Defaults to 'v1' when not specified.
+    attr_reader :model
+    # @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 voice_id [Vapi::FallbackRimeAiVoiceId] This is the provider-specific ID that will be used.
+    # @param model [Vapi::FallbackRimeAiVoiceModel] This is the model that will be used. Defaults to 'v1' when not specified.
+    # @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::FallbackRimeAiVoice]
+    def initialize(voice_id:, model: OMIT, speed: OMIT, chunk_plan: OMIT, additional_properties: nil)
+      @voice_id = voice_id
+      @model = model if model != OMIT
+      @speed = speed if speed != OMIT
+      @chunk_plan = chunk_plan if chunk_plan != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "voiceId": voice_id, "model": model, "speed": speed, "chunkPlan": chunk_plan }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of FallbackRimeAiVoice
+    #
+    # @param json_object [String]
+    # @return [Vapi::FallbackRimeAiVoice]
+    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::FallbackRimeAiVoiceId.from_json(json_object: voice_id)
+      end
+      model = parsed_json["model"]
+      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(
+        voice_id: voice_id,
+        model: model,
+        speed: speed,
+        chunk_plan: chunk_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FallbackRimeAiVoice 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::FallbackRimeAiVoiceId.validate_raw(obj: obj.voice_id)
+      obj.model&.is_a?(Vapi::FallbackRimeAiVoiceModel) != false || raise("Passed value for field obj.model 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_rime_ai_voice_id.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vapi
+  # This is the provider-specific ID that will be used.
+  class FallbackRimeAiVoiceId
+    # Deserialize a JSON object to an instance of FallbackRimeAiVoiceId
+    #
+    # @param json_object [String]
+    # @return [Vapi::FallbackRimeAiVoiceId]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        struct.is_a?(Vapi::FallbackRimeAiVoiceIdEnum) != 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::FallbackRimeAiVoiceIdEnum) != 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_rime_ai_voice_id_enum.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Vapi
+  class FallbackRimeAiVoiceIdEnum
+    MARSH = "marsh"
+    BAYOU = "bayou"
+    CREEK = "creek"
+    BROOK = "brook"
+    FLOWER = "flower"
+    SPORE = "spore"
+    GLACIER = "glacier"
+    GULCH = "gulch"
+    ALPINE = "alpine"
+    COVE = "cove"
+    LAGOON = "lagoon"
+    TUNDRA = "tundra"
+    STEPPE = "steppe"
+    MESA = "mesa"
+    GROVE = "grove"
+    RAINFOREST = "rainforest"
+    MORAINE = "moraine"
+    WILDFLOWER = "wildflower"
+    PEAK = "peak"
+    BOULDER = "boulder"
+    ABBIE = "abbie"
+    ALLISON = "allison"
+    ALLY = "ally"
+    ALONA = "alona"
+    AMBER = "amber"
+    ANA = "ana"
+    ANTOINE = "antoine"
+    ARMON = "armon"
+    BRENDA = "brenda"
+    BRITTANY = "brittany"
+    CAROL = "carol"
+    COLIN = "colin"
+    COURTNEY = "courtney"
+    ELENA = "elena"
+    ELLIOT = "elliot"
+    EVA = "eva"
+    GEOFF = "geoff"
+    GERALD = "gerald"
+    HANK = "hank"
+    HELEN = "helen"
+    HERA = "hera"
+    JEN = "jen"
+    JOE = "joe"
+    JOY = "joy"
+    JUAN = "juan"
+    KENDRA = "kendra"
+    KENDRICK = "kendrick"
+    KENNETH = "kenneth"
+    KEVIN = "kevin"
+    KRIS = "kris"
+    LINDA = "linda"
+    MADISON = "madison"
+    MARGE = "marge"
+    MARINA = "marina"
+    MARISSA = "marissa"
+    MARTA = "marta"
+    MAYA = "maya"
+    NICHOLAS = "nicholas"
+    NYLES = "nyles"
+    PHIL = "phil"
+    REBA = "reba"
+    REX = "rex"
+    RICK = "rick"
+    RITU = "ritu"
+    ROB = "rob"
+    RODNEY = "rodney"
+    ROHAN = "rohan"
+    ROSCO = "rosco"
+    SAMANTHA = "samantha"
+    SANDY = "sandy"
+    SELENA = "selena"
+    SETH = "seth"
+    SHARON = "sharon"
+    STAN = "stan"
+    TAMRA = "tamra"
+    TANYA = "tanya"
+    TIBUR = "tibur"
+    TJ = "tj"
+    TYLER = "tyler"
+    VIV = "viv"
+    YADIRA = "yadira"
+  end
+end

data/lib/vapi_server_sdk/types/fallback_rime_ai_voice_model.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the model that will be used. Defaults to 'v1' when not specified.
+  class FallbackRimeAiVoiceModel
+    V_1 = "v1"
+    MIST = "mist"
+  end
+end