vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/fallback_deepgram_transcriber_language.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Vapi
+  class FallbackDeepgramTranscriberLanguage
+    BG = "bg"
+    CA = "ca"
+    CS = "cs"
+    DA = "da"
+    DA_DK = "da-DK"
+    DE = "de"
+    DE_CH = "de-CH"
+    EL = "el"
+    EN = "en"
+    EN_AU = "en-AU"
+    EN_GB = "en-GB"
+    EN_IN = "en-IN"
+    EN_NZ = "en-NZ"
+    EN_US = "en-US"
+    ES = "es"
+    ES_419 = "es-419"
+    ES_LATAM = "es-LATAM"
+    ET = "et"
+    FI = "fi"
+    FR = "fr"
+    FR_CA = "fr-CA"
+    HI = "hi"
+    HI_LATN = "hi-Latn"
+    HU = "hu"
+    ID = "id"
+    IT = "it"
+    JA = "ja"
+    KO = "ko"
+    KO_KR = "ko-KR"
+    LT = "lt"
+    LV = "lv"
+    MS = "ms"
+    MULTI = "multi"
+    NL = "nl"
+    NL_BE = "nl-BE"
+    NO = "no"
+    PL = "pl"
+    PT = "pt"
+    PT_BR = "pt-BR"
+    RO = "ro"
+    RU = "ru"
+    SK = "sk"
+    SV = "sv"
+    SV_SE = "sv-SE"
+    TA = "ta"
+    TAQ = "taq"
+    TH = "th"
+    TH_TH = "th-TH"
+    TR = "tr"
+    UK = "uk"
+    VI = "vi"
+    ZH = "zh"
+    ZH_CN = "zh-CN"
+    ZH_HANS = "zh-Hans"
+    ZH_HANT = "zh-Hant"
+    ZH_TW = "zh-TW"
+  end
+end

data/lib/vapi_server_sdk/types/fallback_deepgram_transcriber_model.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Vapi
+  class FallbackDeepgramTranscriberModel
+    NOVA_3 = "nova-3"
+    NOVA_3_GENERAL = "nova-3-general"
+    NOVA_3_MEDICAL = "nova-3-medical"
+    NOVA_2 = "nova-2"
+    NOVA_2_GENERAL = "nova-2-general"
+    NOVA_2_MEETING = "nova-2-meeting"
+    NOVA_2_PHONECALL = "nova-2-phonecall"
+    NOVA_2_FINANCE = "nova-2-finance"
+    NOVA_2_CONVERSATIONALAI = "nova-2-conversationalai"
+    NOVA_2_VOICEMAIL = "nova-2-voicemail"
+    NOVA_2_VIDEO = "nova-2-video"
+    NOVA_2_MEDICAL = "nova-2-medical"
+    NOVA_2_DRIVETHRU = "nova-2-drivethru"
+    NOVA_2_AUTOMOTIVE = "nova-2-automotive"
+    NOVA = "nova"
+    NOVA_GENERAL = "nova-general"
+    NOVA_PHONECALL = "nova-phonecall"
+    NOVA_MEDICAL = "nova-medical"
+    ENHANCED = "enhanced"
+    ENHANCED_GENERAL = "enhanced-general"
+    ENHANCED_MEETING = "enhanced-meeting"
+    ENHANCED_PHONECALL = "enhanced-phonecall"
+    ENHANCED_FINANCE = "enhanced-finance"
+    BASE = "base"
+    BASE_GENERAL = "base-general"
+    BASE_MEETING = "base-meeting"
+    BASE_PHONECALL = "base-phonecall"
+    BASE_FINANCE = "base-finance"
+    BASE_CONVERSATIONALAI = "base-conversationalai"
+    BASE_VOICEMAIL = "base-voicemail"
+    BASE_VIDEO = "base-video"
+  end
+end

data/lib/vapi_server_sdk/types/fallback_deepgram_voice.rb

@@ -1,14 +1,25 @@
 # frozen_string_literal: true
 
 require_relative "fallback_deepgram_voice_id"
+require_relative "fallback_deepgram_voice_model"
 require_relative "chunk_plan"
 require "ostruct"
 require "json"
 
 module Vapi
   class FallbackDeepgramVoice
+    # @return [Boolean] This is the flag to toggle voice caching for the assistant.
+    attr_reader :caching_enabled
     # @return [Vapi::FallbackDeepgramVoiceId] This is the provider-specific ID that will be used.
     attr_reader :voice_id
+    # @return [Vapi::FallbackDeepgramVoiceModel] This is the model that will be used. Defaults to 'aura-2' when not specified.
+    attr_reader :model
+    # @return [Boolean] If set to true, this will add mip_opt_out=true as a query parameter of all API
+    #  requests. See
+    #  gram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out
+    #  This will only be used if you are using your own Deepgram API key.
+    #  @default false
+    attr_reader :mip_opt_out
     # @return [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
     #  provider.
     attr_reader :chunk_plan
@@ -20,16 +31,33 @@ module Vapi
 
     OMIT = Object.new
 
+    # @param caching_enabled [Boolean] This is the flag to toggle voice caching for the assistant.
     # @param voice_id [Vapi::FallbackDeepgramVoiceId] This is the provider-specific ID that will be used.
+    # @param model [Vapi::FallbackDeepgramVoiceModel] This is the model that will be used. Defaults to 'aura-2' when not specified.
+    # @param mip_opt_out [Boolean] If set to true, this will add mip_opt_out=true as a query parameter of all API
+    #  requests. See
+    #  gram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out
+    #  This will only be used if you are using your own Deepgram API key.
+    #  @default false
     # @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::FallbackDeepgramVoice]
-    def initialize(voice_id:, chunk_plan: OMIT, additional_properties: nil)
+    def initialize(voice_id:, caching_enabled: OMIT, model: OMIT, mip_opt_out: OMIT, chunk_plan: OMIT,
+                   additional_properties: nil)
+      @caching_enabled = caching_enabled if caching_enabled != OMIT
       @voice_id = voice_id
+      @model = model if model != OMIT
+      @mip_opt_out = mip_opt_out if mip_opt_out != OMIT
       @chunk_plan = chunk_plan if chunk_plan != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "voiceId": voice_id, "chunkPlan": chunk_plan }.reject do |_k, v|
+      @_field_set = {
+        "cachingEnabled": caching_enabled,
+        "voiceId": voice_id,
+        "model": model,
+        "mipOptOut": mip_opt_out,
+        "chunkPlan": chunk_plan
+      }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -41,12 +69,10 @@ 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::FallbackDeepgramVoiceId.from_json(json_object: voice_id)
-      end
+      caching_enabled = parsed_json["cachingEnabled"]
+      voice_id = parsed_json["voiceId"]
+      model = parsed_json["model"]
+      mip_opt_out = parsed_json["mipOptOut"]
       if parsed_json["chunkPlan"].nil?
         chunk_plan = nil
       else
@@ -54,7 +80,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,
+        mip_opt_out: mip_opt_out,
         chunk_plan: chunk_plan,
         additional_properties: struct
       )
@@ -74,7 +103,10 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      Vapi::FallbackDeepgramVoiceId.validate_raw(obj: obj.voice_id)
+      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?(Vapi::FallbackDeepgramVoiceId) != false || raise("Passed value for field obj.voice_id is not the expected type, validation failed.")
+      obj.model&.is_a?(Vapi::FallbackDeepgramVoiceModel) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
+      obj.mip_opt_out&.is_a?(Boolean) != false || raise("Passed value for field obj.mip_opt_out is not the expected type, validation failed.")
       obj.chunk_plan.nil? || Vapi::ChunkPlan.validate_raw(obj: obj.chunk_plan)
     end
   end

data/lib/vapi_server_sdk/types/fallback_deepgram_voice_id.rb

@@ -1,53 +1,52 @@
 # frozen_string_literal: true
 
-require "json"
-
 module Vapi
   # This is the provider-specific ID that will be used.
   class FallbackDeepgramVoiceId
-    # Deserialize a JSON object to an instance of FallbackDeepgramVoiceId
-    #
-    # @param json_object [String]
-    # @return [Vapi::FallbackDeepgramVoiceId]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      begin
-        struct.is_a?(Vapi::FallbackDeepgramVoiceIdEnum) != 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::FallbackDeepgramVoiceIdEnum) != 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
+    ASTERIA = "asteria"
+    LUNA = "luna"
+    STELLA = "stella"
+    ATHENA = "athena"
+    HERA = "hera"
+    ORION = "orion"
+    ARCAS = "arcas"
+    PERSEUS = "perseus"
+    ANGUS = "angus"
+    ORPHEUS = "orpheus"
+    HELIOS = "helios"
+    ZEUS = "zeus"
+    THALIA = "thalia"
+    ANDROMEDA = "andromeda"
+    HELENA = "helena"
+    APOLLO = "apollo"
+    ARIES = "aries"
+    AMALTHEA = "amalthea"
+    ATLAS = "atlas"
+    AURORA = "aurora"
+    CALLISTA = "callista"
+    CORA = "cora"
+    CORDELIA = "cordelia"
+    DELIA = "delia"
+    DRACO = "draco"
+    ELECTRA = "electra"
+    HARMONIA = "harmonia"
+    HERMES = "hermes"
+    HYPERION = "hyperion"
+    IRIS = "iris"
+    JANUS = "janus"
+    JUNO = "juno"
+    JUPITER = "jupiter"
+    MARS = "mars"
+    MINERVA = "minerva"
+    NEPTUNE = "neptune"
+    ODYSSEUS = "odysseus"
+    OPHELIA = "ophelia"
+    PANDORA = "pandora"
+    PHOEBE = "phoebe"
+    PLUTO = "pluto"
+    SATURN = "saturn"
+    SELENE = "selene"
+    THEIA = "theia"
+    VESTA = "vesta"
   end
 end

data/lib/vapi_server_sdk/types/fallback_deepgram_voice_model.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the model that will be used. Defaults to 'aura-2' when not specified.
+  class FallbackDeepgramVoiceModel
+    AURA = "aura"
+    AURA_2 = "aura-2"
+  end
+end

data/lib/vapi_server_sdk/types/fallback_eleven_labs_transcriber.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "fallback_eleven_labs_transcriber_language"
+require "ostruct"
+require "json"
+
+module Vapi
+  class FallbackElevenLabsTranscriber
+    # @return [String] This is the model that will be used for the transcription.
+    attr_reader :model
+    # @return [Vapi::FallbackElevenLabsTranscriberLanguage]
+    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 [String] This is the model that will be used for the transcription.
+    # @param language [Vapi::FallbackElevenLabsTranscriberLanguage]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::FallbackElevenLabsTranscriber]
+    def initialize(model: OMIT, language: OMIT, additional_properties: nil)
+      @model = model if model != OMIT
+      @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 FallbackElevenLabsTranscriber
+    #
+    # @param json_object [String]
+    # @return [Vapi::FallbackElevenLabsTranscriber]
+    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 FallbackElevenLabsTranscriber 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?(String) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
+      obj.language&.is_a?(Vapi::FallbackElevenLabsTranscriberLanguage) != 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_eleven_labs_transcriber_language.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+module Vapi
+  class FallbackElevenLabsTranscriberLanguage
+    AA = "aa"
+    AB = "ab"
+    AE = "ae"
+    AF = "af"
+    AK = "ak"
+    AM = "am"
+    AN = "an"
+    AR = "ar"
+    AS = "as"
+    AV = "av"
+    AY = "ay"
+    AZ = "az"
+    BA = "ba"
+    BE = "be"
+    BG = "bg"
+    BH = "bh"
+    BI = "bi"
+    BM = "bm"
+    BN = "bn"
+    BO = "bo"
+    BR = "br"
+    BS = "bs"
+    CA = "ca"
+    CE = "ce"
+    CH = "ch"
+    CO = "co"
+    CR = "cr"
+    CS = "cs"
+    CU = "cu"
+    CV = "cv"
+    CY = "cy"
+    DA = "da"
+    DE = "de"
+    DV = "dv"
+    DZ = "dz"
+    EE = "ee"
+    EL = "el"
+    EN = "en"
+    EO = "eo"
+    ES = "es"
+    ET = "et"
+    EU = "eu"
+    FA = "fa"
+    FF = "ff"
+    FI = "fi"
+    FJ = "fj"
+    FO = "fo"
+    FR = "fr"
+    FY = "fy"
+    GA = "ga"
+    GD = "gd"
+    GL = "gl"
+    GN = "gn"
+    GU = "gu"
+    GV = "gv"
+    HA = "ha"
+    HE = "he"
+    HI = "hi"
+    HO = "ho"
+    HR = "hr"
+    HT = "ht"
+    HU = "hu"
+    HY = "hy"
+    HZ = "hz"
+    IA = "ia"
+    ID = "id"
+    IE = "ie"
+    IG = "ig"
+    II = "ii"
+    IK = "ik"
+    IO = "io"
+    IS = "is"
+    IT = "it"
+    IU = "iu"
+    JA = "ja"
+    JV = "jv"
+    KA = "ka"
+    KG = "kg"
+    KI = "ki"
+    KJ = "kj"
+    KK = "kk"
+    KL = "kl"
+    KM = "km"
+    KN = "kn"
+    KO = "ko"
+    KR = "kr"
+    KS = "ks"
+    KU = "ku"
+    KV = "kv"
+    KW = "kw"
+    KY = "ky"
+    LA = "la"
+    LB = "lb"
+    LG = "lg"
+    LI = "li"
+    LN = "ln"
+    LO = "lo"
+    LT = "lt"
+    LU = "lu"
+    LV = "lv"
+    MG = "mg"
+    MH = "mh"
+    MI = "mi"
+    MK = "mk"
+    ML = "ml"
+    MN = "mn"
+    MR = "mr"
+    MS = "ms"
+    MT = "mt"
+    MY = "my"
+    NA = "na"
+    NB = "nb"
+    ND = "nd"
+    NE = "ne"
+    NG = "ng"
+    NL = "nl"
+    NN = "nn"
+    NO = "no"
+    NR = "nr"
+    NV = "nv"
+    NY = "ny"
+    OC = "oc"
+    OJ = "oj"
+    OM = "om"
+    OR = "or"
+    OS = "os"
+    PA = "pa"
+    PI = "pi"
+    PL = "pl"
+    PS = "ps"
+    PT = "pt"
+    QU = "qu"
+    RM = "rm"
+    RN = "rn"
+    RO = "ro"
+    RU = "ru"
+    RW = "rw"
+    SA = "sa"
+    SC = "sc"
+    SD = "sd"
+    SE = "se"
+    SG = "sg"
+    SI = "si"
+    SK = "sk"
+    SL = "sl"
+    SM = "sm"
+    SN = "sn"
+    SO = "so"
+    SQ = "sq"
+    SR = "sr"
+    SS = "ss"
+    ST = "st"
+    SU = "su"
+    SV = "sv"
+    SW = "sw"
+    TA = "ta"
+    TE = "te"
+    TG = "tg"
+    TH = "th"
+    TI = "ti"
+    TK = "tk"
+    TL = "tl"
+    TN = "tn"
+    TO = "to"
+    TR = "tr"
+    TS = "ts"
+    TT = "tt"
+    TW = "tw"
+    TY = "ty"
+    UG = "ug"
+    UK = "uk"
+    UR = "ur"
+    UZ = "uz"
+    VE = "ve"
+    VI = "vi"
+    VO = "vo"
+    WA = "wa"
+    WO = "wo"
+    XH = "xh"
+    YI = "yi"
+    YUE = "yue"
+    YO = "yo"
+    ZA = "za"
+    ZH = "zh"
+    ZU = "zu"
+  end
+end