vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/fallback_speechmatics_transcriber.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "fallback_speechmatics_transcriber_language"
+require "ostruct"
+require "json"
+
+module Vapi
+  class FallbackSpeechmaticsTranscriber
+    # @return [String] This is the model that will be used for the transcription.
+    attr_reader :model
+    # @return [Vapi::FallbackSpeechmaticsTranscriberLanguage]
+    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::FallbackSpeechmaticsTranscriberLanguage]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::FallbackSpeechmaticsTranscriber]
+    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 FallbackSpeechmaticsTranscriber
+    #
+    # @param json_object [String]
+    # @return [Vapi::FallbackSpeechmaticsTranscriber]
+    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 FallbackSpeechmaticsTranscriber 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::FallbackSpeechmaticsTranscriberLanguage) != 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_speechmatics_transcriber_language.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Vapi
+  class FallbackSpeechmaticsTranscriberLanguage
+    AUTO = "auto"
+    AR = "ar"
+    BA = "ba"
+    EU = "eu"
+    BE = "be"
+    BN = "bn"
+    BG = "bg"
+    YUE = "yue"
+    CA = "ca"
+    HR = "hr"
+    CS = "cs"
+    DA = "da"
+    NL = "nl"
+    EN = "en"
+    EO = "eo"
+    ET = "et"
+    FI = "fi"
+    FR = "fr"
+    GL = "gl"
+    DE = "de"
+    EL = "el"
+    HE = "he"
+    HI = "hi"
+    HU = "hu"
+    ID = "id"
+    IA = "ia"
+    GA = "ga"
+    IT = "it"
+    JA = "ja"
+    KO = "ko"
+    LV = "lv"
+    LT = "lt"
+    MS = "ms"
+    MT = "mt"
+    CMN = "cmn"
+    MR = "mr"
+    MN = "mn"
+    NO = "no"
+    FA = "fa"
+    PL = "pl"
+    PT = "pt"
+    RO = "ro"
+    RU = "ru"
+    SK = "sk"
+    SL = "sl"
+    ES = "es"
+    SW = "sw"
+    SV = "sv"
+    TA = "ta"
+    TH = "th"
+    TR = "tr"
+    UK = "uk"
+    UR = "ur"
+    UG = "ug"
+    VI = "vi"
+    CY = "cy"
+  end
+end

data/lib/vapi_server_sdk/types/fallback_talkscriber_transcriber.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative "fallback_talkscriber_transcriber_language"
+require "ostruct"
+require "json"
+
+module Vapi
+  class FallbackTalkscriberTranscriber
+    # @return [String] This is the model that will be used for the transcription.
+    attr_reader :model
+    # @return [Vapi::FallbackTalkscriberTranscriberLanguage] This is the language that will be set for the transcription. The list of
+    #  languages Whisper supports can be found here:
+    #  https://github.com/openai/whisper/blob/main/whisper/tokenizer.py
+    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::FallbackTalkscriberTranscriberLanguage] This is the language that will be set for the transcription. The list of
+    #  languages Whisper supports can be found here:
+    #  https://github.com/openai/whisper/blob/main/whisper/tokenizer.py
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::FallbackTalkscriberTranscriber]
+    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 FallbackTalkscriberTranscriber
+    #
+    # @param json_object [String]
+    # @return [Vapi::FallbackTalkscriberTranscriber]
+    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 FallbackTalkscriberTranscriber 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::FallbackTalkscriberTranscriberLanguage) != 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_talkscriber_transcriber_language.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the language that will be set for the transcription. The list of
+  #  languages Whisper supports can be found here:
+  #  https://github.com/openai/whisper/blob/main/whisper/tokenizer.py
+  class FallbackTalkscriberTranscriberLanguage
+    EN = "en"
+    ZH = "zh"
+    DE = "de"
+    ES = "es"
+    RU = "ru"
+    KO = "ko"
+    FR = "fr"
+    JA = "ja"
+    PT = "pt"
+    TR = "tr"
+    PL = "pl"
+    CA = "ca"
+    NL = "nl"
+    AR = "ar"
+    SV = "sv"
+    IT = "it"
+    ID = "id"
+    HI = "hi"
+    FI = "fi"
+    VI = "vi"
+    HE = "he"
+    UK = "uk"
+    EL = "el"
+    MS = "ms"
+    CS = "cs"
+    RO = "ro"
+    DA = "da"
+    HU = "hu"
+    TA = "ta"
+    NO = "no"
+    TH = "th"
+    UR = "ur"
+    HR = "hr"
+    BG = "bg"
+    LT = "lt"
+    LA = "la"
+    MI = "mi"
+    ML = "ml"
+    CY = "cy"
+    SK = "sk"
+    TE = "te"
+    FA = "fa"
+    LV = "lv"
+    BN = "bn"
+    SR = "sr"
+    AZ = "az"
+    SL = "sl"
+    KN = "kn"
+    ET = "et"
+    MK = "mk"
+    BR = "br"
+    EU = "eu"
+    IS = "is"
+    HY = "hy"
+    NE = "ne"
+    MN = "mn"
+    BS = "bs"
+    KK = "kk"
+    SQ = "sq"
+    SW = "sw"
+    GL = "gl"
+    MR = "mr"
+    PA = "pa"
+    SI = "si"
+    KM = "km"
+    SN = "sn"
+    YO = "yo"
+    SO = "so"
+    AF = "af"
+    OC = "oc"
+    KA = "ka"
+    BE = "be"
+    TG = "tg"
+    SD = "sd"
+    GU = "gu"
+    AM = "am"
+    YI = "yi"
+    LO = "lo"
+    UZ = "uz"
+    FO = "fo"
+    HT = "ht"
+    PS = "ps"
+    TK = "tk"
+    NN = "nn"
+    MT = "mt"
+    SA = "sa"
+    LB = "lb"
+    MY = "my"
+    BO = "bo"
+    TL = "tl"
+    MG = "mg"
+    AS = "as"
+    TT = "tt"
+    HAW = "haw"
+    LN = "ln"
+    HA = "ha"
+    BA = "ba"
+    JW = "jw"
+    SU = "su"
+    YUE = "yue"
+  end
+end

data/lib/vapi_server_sdk/types/fallback_tavus_voice.rb

@@ -8,6 +8,8 @@ require "json"
 
 module Vapi
   class FallbackTavusVoice
+    # @return [Boolean] This is the flag to toggle voice caching for the assistant.
+    attr_reader :caching_enabled
     # @return [Vapi::FallbackTavusVoiceVoiceId] This is the provider-specific ID that will be used.
     attr_reader :voice_id
     # @return [String] This is the unique identifier for the persona that the replica will use in the
@@ -37,6 +39,7 @@ module Vapi
 
     OMIT = Object.new
 
+    # @param caching_enabled [Boolean] This is the flag to toggle voice caching for the assistant.
     # @param voice_id [Vapi::FallbackTavusVoiceVoiceId] This is the provider-specific ID that will be used.
     # @param persona_id [String] This is the unique identifier for the persona that the replica will use in the
     #  conversation.
@@ -52,8 +55,9 @@ module Vapi
     #  provider.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::FallbackTavusVoice]
-    def initialize(voice_id:, persona_id: OMIT, callback_url: OMIT, conversation_name: OMIT,
+    def initialize(voice_id:, caching_enabled: OMIT, persona_id: OMIT, callback_url: OMIT, conversation_name: OMIT,
                    conversational_context: OMIT, custom_greeting: OMIT, properties: OMIT, chunk_plan: OMIT, additional_properties: nil)
+      @caching_enabled = caching_enabled if caching_enabled != OMIT
       @voice_id = voice_id
       @persona_id = persona_id if persona_id != OMIT
       @callback_url = callback_url if callback_url != OMIT
@@ -64,6 +68,7 @@ module Vapi
       @chunk_plan = chunk_plan if chunk_plan != OMIT
       @additional_properties = additional_properties
       @_field_set = {
+        "cachingEnabled": caching_enabled,
         "voiceId": voice_id,
         "personaId": persona_id,
         "callbackUrl": callback_url,
@@ -84,6 +89,7 @@ module Vapi
     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"]
       if parsed_json["voiceId"].nil?
         voice_id = nil
       else
@@ -108,6 +114,7 @@ module Vapi
         chunk_plan = Vapi::ChunkPlan.from_json(json_object: chunk_plan)
       end
       new(
+        caching_enabled: caching_enabled,
         voice_id: voice_id,
         persona_id: persona_id,
         callback_url: callback_url,
@@ -134,6 +141,7 @@ module Vapi
     # @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.")
       Vapi::FallbackTavusVoiceVoiceId.validate_raw(obj: obj.voice_id)
       obj.persona_id&.is_a?(String) != false || raise("Passed value for field obj.persona_id is not the expected type, validation failed.")
       obj.callback_url&.is_a?(String) != false || raise("Passed value for field obj.callback_url is not the expected type, validation failed.")

data/lib/vapi_server_sdk/types/fallback_transcriber_plan.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "fallback_transcriber_plan_transcribers_item"
+require "ostruct"
+require "json"
+
+module Vapi
+  class FallbackTranscriberPlan
+    # @return [Array<Vapi::FallbackTranscriberPlanTranscribersItem>]
+    attr_reader :transcribers
+    # @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 transcribers [Array<Vapi::FallbackTranscriberPlanTranscribersItem>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::FallbackTranscriberPlan]
+    def initialize(transcribers:, additional_properties: nil)
+      @transcribers = transcribers
+      @additional_properties = additional_properties
+      @_field_set = { "transcribers": transcribers }
+    end
+
+    # Deserialize a JSON object to an instance of FallbackTranscriberPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::FallbackTranscriberPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      transcribers = parsed_json["transcribers"]&.map do |item|
+        item = item.to_json
+        Vapi::FallbackTranscriberPlanTranscribersItem.from_json(json_object: item)
+      end
+      new(transcribers: transcribers, additional_properties: struct)
+    end
+
+    # Serialize an instance of FallbackTranscriberPlan 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.transcribers.is_a?(Array) != false || raise("Passed value for field obj.transcribers is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/fallback_transcriber_plan_transcribers_item.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "fallback_assembly_ai_transcriber"
+require_relative "fallback_azure_speech_transcriber"
+require_relative "fallback_custom_transcriber"
+require_relative "fallback_deepgram_transcriber"
+require_relative "fallback_eleven_labs_transcriber"
+require_relative "fallback_gladia_transcriber"
+require_relative "fallback_google_transcriber"
+require_relative "fallback_talkscriber_transcriber"
+require_relative "fallback_speechmatics_transcriber"
+require_relative "fallback_open_ai_transcriber"
+require_relative "fallback_cartesia_transcriber"
+
+module Vapi
+  class FallbackTranscriberPlanTranscribersItem
+    # @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::FallbackTranscriberPlanTranscribersItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  FallbackTranscriberPlanTranscribersItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::FallbackTranscriberPlanTranscribersItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.provider
+               when "assembly-ai"
+                 Vapi::FallbackAssemblyAiTranscriber.from_json(json_object: json_object)
+               when "azure"
+                 Vapi::FallbackAzureSpeechTranscriber.from_json(json_object: json_object)
+               when "custom-transcriber"
+                 Vapi::FallbackCustomTranscriber.from_json(json_object: json_object)
+               when "deepgram"
+                 Vapi::FallbackDeepgramTranscriber.from_json(json_object: json_object)
+               when "11labs"
+                 Vapi::FallbackElevenLabsTranscriber.from_json(json_object: json_object)
+               when "gladia"
+                 Vapi::FallbackGladiaTranscriber.from_json(json_object: json_object)
+               when "google"
+                 Vapi::FallbackGoogleTranscriber.from_json(json_object: json_object)
+               when "talkscriber"
+                 Vapi::FallbackTalkscriberTranscriber.from_json(json_object: json_object)
+               when "speechmatics"
+                 Vapi::FallbackSpeechmaticsTranscriber.from_json(json_object: json_object)
+               when "openai"
+                 Vapi::FallbackOpenAiTranscriber.from_json(json_object: json_object)
+               when "cartesia"
+                 Vapi::FallbackCartesiaTranscriber.from_json(json_object: json_object)
+               else
+                 Vapi::FallbackAssemblyAiTranscriber.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 "assembly-ai"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "azure"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "custom-transcriber"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "deepgram"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "11labs"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "gladia"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "google"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "talkscriber"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "speechmatics"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "openai"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "cartesia"
+        { **@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 "assembly-ai"
+        Vapi::FallbackAssemblyAiTranscriber.validate_raw(obj: obj)
+      when "azure"
+        Vapi::FallbackAzureSpeechTranscriber.validate_raw(obj: obj)
+      when "custom-transcriber"
+        Vapi::FallbackCustomTranscriber.validate_raw(obj: obj)
+      when "deepgram"
+        Vapi::FallbackDeepgramTranscriber.validate_raw(obj: obj)
+      when "11labs"
+        Vapi::FallbackElevenLabsTranscriber.validate_raw(obj: obj)
+      when "gladia"
+        Vapi::FallbackGladiaTranscriber.validate_raw(obj: obj)
+      when "google"
+        Vapi::FallbackGoogleTranscriber.validate_raw(obj: obj)
+      when "talkscriber"
+        Vapi::FallbackTalkscriberTranscriber.validate_raw(obj: obj)
+      when "speechmatics"
+        Vapi::FallbackSpeechmaticsTranscriber.validate_raw(obj: obj)
+      when "openai"
+        Vapi::FallbackOpenAiTranscriber.validate_raw(obj: obj)
+      when "cartesia"
+        Vapi::FallbackCartesiaTranscriber.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::FallbackAssemblyAiTranscriber]
+    # @return [Vapi::FallbackTranscriberPlanTranscribersItem]
+    def self.assembly_ai(member:)
+      new(member: member, discriminant: "assembly-ai")
+    end
+
+    # @param member [Vapi::FallbackAzureSpeechTranscriber]
+    # @return [Vapi::FallbackTranscriberPlanTranscribersItem]
+    def self.azure(member:)
+      new(member: member, discriminant: "azure")
+    end
+
+    # @param member [Vapi::FallbackCustomTranscriber]
+    # @return [Vapi::FallbackTranscriberPlanTranscribersItem]
+    def self.custom_transcriber(member:)
+      new(member: member, discriminant: "custom-transcriber")
+    end
+
+    # @param member [Vapi::FallbackDeepgramTranscriber]
+    # @return [Vapi::FallbackTranscriberPlanTranscribersItem]
+    def self.deepgram(member:)
+      new(member: member, discriminant: "deepgram")
+    end
+
+    # @param member [Vapi::FallbackElevenLabsTranscriber]
+    # @return [Vapi::FallbackTranscriberPlanTranscribersItem]
+    def self._11_labs(member:)
+      new(member: member, discriminant: "11labs")
+    end
+
+    # @param member [Vapi::FallbackGladiaTranscriber]
+    # @return [Vapi::FallbackTranscriberPlanTranscribersItem]
+    def self.gladia(member:)
+      new(member: member, discriminant: "gladia")
+    end
+
+    # @param member [Vapi::FallbackGoogleTranscriber]
+    # @return [Vapi::FallbackTranscriberPlanTranscribersItem]
+    def self.google(member:)
+      new(member: member, discriminant: "google")
+    end
+
+    # @param member [Vapi::FallbackTalkscriberTranscriber]
+    # @return [Vapi::FallbackTranscriberPlanTranscribersItem]
+    def self.talkscriber(member:)
+      new(member: member, discriminant: "talkscriber")
+    end
+
+    # @param member [Vapi::FallbackSpeechmaticsTranscriber]
+    # @return [Vapi::FallbackTranscriberPlanTranscribersItem]
+    def self.speechmatics(member:)
+      new(member: member, discriminant: "speechmatics")
+    end
+
+    # @param member [Vapi::FallbackOpenAiTranscriber]
+    # @return [Vapi::FallbackTranscriberPlanTranscribersItem]
+    def self.openai(member:)
+      new(member: member, discriminant: "openai")
+    end
+
+    # @param member [Vapi::FallbackCartesiaTranscriber]
+    # @return [Vapi::FallbackTranscriberPlanTranscribersItem]
+    def self.cartesia(member:)
+      new(member: member, discriminant: "cartesia")
+    end
+  end
+end