vapi_server_sdk 0.1.0 → 0.3.0

data/lib/vapi_server_sdk/types/perplexity_ai_model.rb

@@ -2,7 +2,7 @@
 
 require_relative "open_ai_message"
 require_relative "perplexity_ai_model_tools_item"
-require_relative "knowledge_base"
+require_relative "create_custom_knowledge_base_dto"
 require "ostruct"
 require "json"
 
@@ -18,13 +18,15 @@ module Vapi
     #  tools, use `tools`.
     #  Both `tools` and `toolIds` can be used together.
     attr_reader :tool_ids
+    # @return [Vapi::CreateCustomKnowledgeBaseDto] These are the options for the knowledge base.
+    attr_reader :knowledge_base
+    # @return [String] This is the ID of the knowledge base the model will use.
+    attr_reader :knowledge_base_id
     # @return [String] This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b
     attr_reader :model
     # @return [Float] This is the temperature that will be used for calls. Default is 0 to leverage
     #  caching for lower latency.
     attr_reader :temperature
-    # @return [Vapi::KnowledgeBase] These are the options for the knowledge base.
-    attr_reader :knowledge_base
     # @return [Float] This is the max number of tokens that the assistant will be allowed to generate
     #  in each turn of the conversation. Default is 250.
     attr_reader :max_tokens
@@ -55,10 +57,11 @@ module Vapi
     # @param tool_ids [Array<String>] These are the tools that the assistant can use during the call. To use transient
     #  tools, use `tools`.
     #  Both `tools` and `toolIds` can be used together.
+    # @param knowledge_base [Vapi::CreateCustomKnowledgeBaseDto] These are the options for the knowledge base.
+    # @param knowledge_base_id [String] This is the ID of the knowledge base the model will use.
     # @param model [String] This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b
     # @param temperature [Float] This is the temperature that will be used for calls. Default is 0 to leverage
     #  caching for lower latency.
-    # @param knowledge_base [Vapi::KnowledgeBase] These are the options for the knowledge base.
     # @param max_tokens [Float] This is the max number of tokens that the assistant will be allowed to generate
     #  in each turn of the conversation. Default is 250.
     # @param emotion_recognition_enabled [Boolean] This determines whether we detect user's emotion while they speak and send it as
@@ -73,14 +76,15 @@ module Vapi
     #  @default 0
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::PerplexityAiModel]
-    def initialize(model:, messages: OMIT, tools: OMIT, tool_ids: OMIT, temperature: OMIT, knowledge_base: OMIT,
-                   max_tokens: OMIT, emotion_recognition_enabled: OMIT, num_fast_turns: OMIT, additional_properties: nil)
+    def initialize(model:, messages: OMIT, tools: OMIT, tool_ids: OMIT, knowledge_base: OMIT, knowledge_base_id: OMIT,
+                   temperature: OMIT, max_tokens: OMIT, emotion_recognition_enabled: OMIT, num_fast_turns: OMIT, additional_properties: nil)
       @messages = messages if messages != OMIT
       @tools = tools if tools != OMIT
       @tool_ids = tool_ids if tool_ids != OMIT
+      @knowledge_base = knowledge_base if knowledge_base != OMIT
+      @knowledge_base_id = knowledge_base_id if knowledge_base_id != OMIT
       @model = model
       @temperature = temperature if temperature != OMIT
-      @knowledge_base = knowledge_base if knowledge_base != OMIT
       @max_tokens = max_tokens if max_tokens != OMIT
       @emotion_recognition_enabled = emotion_recognition_enabled if emotion_recognition_enabled != OMIT
       @num_fast_turns = num_fast_turns if num_fast_turns != OMIT
@@ -89,9 +93,10 @@ module Vapi
         "messages": messages,
         "tools": tools,
         "toolIds": tool_ids,
+        "knowledgeBase": knowledge_base,
+        "knowledgeBaseId": knowledge_base_id,
         "model": model,
         "temperature": temperature,
-        "knowledgeBase": knowledge_base,
         "maxTokens": max_tokens,
         "emotionRecognitionEnabled": emotion_recognition_enabled,
         "numFastTurns": num_fast_turns
@@ -116,14 +121,15 @@ module Vapi
         Vapi::PerplexityAiModelToolsItem.from_json(json_object: item)
       end
       tool_ids = parsed_json["toolIds"]
-      model = parsed_json["model"]
-      temperature = parsed_json["temperature"]
       if parsed_json["knowledgeBase"].nil?
         knowledge_base = nil
       else
         knowledge_base = parsed_json["knowledgeBase"].to_json
-        knowledge_base = Vapi::KnowledgeBase.from_json(json_object: knowledge_base)
+        knowledge_base = Vapi::CreateCustomKnowledgeBaseDto.from_json(json_object: knowledge_base)
       end
+      knowledge_base_id = parsed_json["knowledgeBaseId"]
+      model = parsed_json["model"]
+      temperature = parsed_json["temperature"]
       max_tokens = parsed_json["maxTokens"]
       emotion_recognition_enabled = parsed_json["emotionRecognitionEnabled"]
       num_fast_turns = parsed_json["numFastTurns"]
@@ -131,9 +137,10 @@ module Vapi
         messages: messages,
         tools: tools,
         tool_ids: tool_ids,
+        knowledge_base: knowledge_base,
+        knowledge_base_id: knowledge_base_id,
         model: model,
         temperature: temperature,
-        knowledge_base: knowledge_base,
         max_tokens: max_tokens,
         emotion_recognition_enabled: emotion_recognition_enabled,
         num_fast_turns: num_fast_turns,
@@ -158,9 +165,10 @@ module Vapi
       obj.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
       obj.tools&.is_a?(Array) != false || raise("Passed value for field obj.tools is not the expected type, validation failed.")
       obj.tool_ids&.is_a?(Array) != false || raise("Passed value for field obj.tool_ids is not the expected type, validation failed.")
+      obj.knowledge_base.nil? || Vapi::CreateCustomKnowledgeBaseDto.validate_raw(obj: obj.knowledge_base)
+      obj.knowledge_base_id&.is_a?(String) != false || raise("Passed value for field obj.knowledge_base_id is not the expected type, validation failed.")
       obj.model.is_a?(String) != false || raise("Passed value for field obj.model 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.knowledge_base.nil? || Vapi::KnowledgeBase.validate_raw(obj: obj.knowledge_base)
       obj.max_tokens&.is_a?(Float) != false || raise("Passed value for field obj.max_tokens is not the expected type, validation failed.")
       obj.emotion_recognition_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.emotion_recognition_enabled is not the expected type, validation failed.")
       obj.num_fast_turns&.is_a?(Float) != false || raise("Passed value for field obj.num_fast_turns is not the expected type, validation failed.")

data/lib/vapi_server_sdk/types/phone_number_paginated_response.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "phone_number_paginated_response_results_item"
+require_relative "pagination_meta"
+require "ostruct"
+require "json"
+
+module Vapi
+  class PhoneNumberPaginatedResponse
+    # @return [Array<Vapi::PhoneNumberPaginatedResponseResultsItem>] A list of phone numbers, which can be of any provider type.
+    attr_reader :results
+    # @return [Vapi::PaginationMeta] Metadata about the pagination.
+    attr_reader :metadata
+    # @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 results [Array<Vapi::PhoneNumberPaginatedResponseResultsItem>] A list of phone numbers, which can be of any provider type.
+    # @param metadata [Vapi::PaginationMeta] Metadata about the pagination.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::PhoneNumberPaginatedResponse]
+    def initialize(results:, metadata:, additional_properties: nil)
+      @results = results
+      @metadata = metadata
+      @additional_properties = additional_properties
+      @_field_set = { "results": results, "metadata": metadata }
+    end
+
+    # Deserialize a JSON object to an instance of PhoneNumberPaginatedResponse
+    #
+    # @param json_object [String]
+    # @return [Vapi::PhoneNumberPaginatedResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      results = parsed_json["results"]&.map do |item|
+        item = item.to_json
+        Vapi::PhoneNumberPaginatedResponseResultsItem.from_json(json_object: item)
+      end
+      if parsed_json["metadata"].nil?
+        metadata = nil
+      else
+        metadata = parsed_json["metadata"].to_json
+        metadata = Vapi::PaginationMeta.from_json(json_object: metadata)
+      end
+      new(
+        results: results,
+        metadata: metadata,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of PhoneNumberPaginatedResponse 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.results.is_a?(Array) != false || raise("Passed value for field obj.results is not the expected type, validation failed.")
+      Vapi::PaginationMeta.validate_raw(obj: obj.metadata)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/phone_number_paginated_response_results_item.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "byo_phone_number"
+require_relative "twilio_phone_number"
+require_relative "vonage_phone_number"
+require_relative "vapi_phone_number"
+
+module Vapi
+  class PhoneNumberPaginatedResponseResultsItem
+    # @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::PhoneNumberPaginatedResponseResultsItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  PhoneNumberPaginatedResponseResultsItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::PhoneNumberPaginatedResponseResultsItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.provider
+               when "byo-phone-number"
+                 Vapi::ByoPhoneNumber.from_json(json_object: json_object)
+               when "twilio"
+                 Vapi::TwilioPhoneNumber.from_json(json_object: json_object)
+               when "vonage"
+                 Vapi::VonagePhoneNumber.from_json(json_object: json_object)
+               when "vapi"
+                 Vapi::VapiPhoneNumber.from_json(json_object: json_object)
+               else
+                 Vapi::ByoPhoneNumber.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 "byo-phone-number"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "twilio"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "vonage"
+        { **@member.to_json, provider: @discriminant }.to_json
+      when "vapi"
+        { **@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 "byo-phone-number"
+        Vapi::ByoPhoneNumber.validate_raw(obj: obj)
+      when "twilio"
+        Vapi::TwilioPhoneNumber.validate_raw(obj: obj)
+      when "vonage"
+        Vapi::VonagePhoneNumber.validate_raw(obj: obj)
+      when "vapi"
+        Vapi::VapiPhoneNumber.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::ByoPhoneNumber]
+    # @return [Vapi::PhoneNumberPaginatedResponseResultsItem]
+    def self.byo_phone_number(member:)
+      new(member: member, discriminant: "byo-phone-number")
+    end
+
+    # @param member [Vapi::TwilioPhoneNumber]
+    # @return [Vapi::PhoneNumberPaginatedResponseResultsItem]
+    def self.twilio(member:)
+      new(member: member, discriminant: "twilio")
+    end
+
+    # @param member [Vapi::VonagePhoneNumber]
+    # @return [Vapi::PhoneNumberPaginatedResponseResultsItem]
+    def self.vonage(member:)
+      new(member: member, discriminant: "vonage")
+    end
+
+    # @param member [Vapi::VapiPhoneNumber]
+    # @return [Vapi::PhoneNumberPaginatedResponseResultsItem]
+    def self.vapi(member:)
+      new(member: member, discriminant: "vapi")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/play_ht_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 [String]
     attr_reader :user_id
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -34,16 +36,19 @@ 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 user_id [String]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::PlayHtCredential]
-    def initialize(provider:, api_key:, id:, org_id:, created_at:, updated_at:, user_id:, additional_properties: nil)
+    def initialize(provider:, api_key:, id:, org_id:, created_at:, updated_at:, user_id:, 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
       @user_id = user_id
       @additional_properties = additional_properties
       @_field_set = {
@@ -53,8 +58,11 @@ module Vapi
         "orgId": org_id,
         "createdAt": created_at,
         "updatedAt": updated_at,
+        "name": name,
         "userId": user_id
-      }
+      }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of PlayHtCredential
@@ -70,6 +78,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"]
       user_id = parsed_json["userId"]
       new(
         provider: provider,
@@ -78,6 +87,7 @@ module Vapi
         org_id: org_id,
         created_at: created_at,
         updated_at: updated_at,
+        name: name,
         user_id: user_id,
         additional_properties: struct
       )
@@ -103,6 +113,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.")
       obj.user_id.is_a?(String) != false || raise("Passed value for field obj.user_id is not the expected type, validation failed.")
     end
   end

data/lib/vapi_server_sdk/types/play_ht_voice.rb

@@ -2,16 +2,15 @@
 
 require_relative "play_ht_voice_id"
 require_relative "play_ht_voice_emotion"
+require_relative "play_ht_voice_model"
+require_relative "play_ht_voice_language"
 require_relative "chunk_plan"
+require_relative "fallback_plan"
 require "ostruct"
 require "json"
 
 module Vapi
   class PlayHtVoice
-    # @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::PlayHtVoiceId] 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.
@@ -36,9 +35,16 @@ module Vapi
     #  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::PlayHtVoiceModel] Playht voice model/engine to use.
+    attr_reader :model
+    # @return [Vapi::PlayHtVoiceLanguage] 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 [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]
@@ -47,9 +53,6 @@ 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 voice_id [Vapi::PlayHtVoiceId] 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
@@ -67,13 +70,16 @@ module Vapi
     #  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::PlayHtVoiceModel] Playht voice model/engine to use.
+    # @param language [Vapi::PlayHtVoiceLanguage] 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 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::PlayHtVoice]
-    def initialize(voice_id:, filler_injection_enabled: OMIT, speed: OMIT, temperature: OMIT, emotion: OMIT,
-                   voice_guidance: OMIT, style_guidance: OMIT, text_guidance: OMIT, chunk_plan: OMIT, additional_properties: nil)
-      @filler_injection_enabled = filler_injection_enabled if filler_injection_enabled != OMIT
+    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, fallback_plan: OMIT, additional_properties: nil)
       @voice_id = voice_id
       @speed = speed if speed != OMIT
       @temperature = temperature if temperature != OMIT
@@ -81,10 +87,12 @@ module Vapi
       @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
+      @fallback_plan = fallback_plan if fallback_plan != OMIT
       @additional_properties = additional_properties
       @_field_set = {
-        "fillerInjectionEnabled": filler_injection_enabled,
         "voiceId": voice_id,
         "speed": speed,
         "temperature": temperature,
@@ -92,7 +100,10 @@ module Vapi
         "voiceGuidance": voice_guidance,
         "styleGuidance": style_guidance,
         "textGuidance": text_guidance,
-        "chunkPlan": chunk_plan
+        "model": model,
+        "language": language,
+        "chunkPlan": chunk_plan,
+        "fallbackPlan": fallback_plan
       }.reject do |_k, v|
         v == OMIT
       end
@@ -105,7 +116,6 @@ 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"]
       if parsed_json["voiceId"].nil?
         voice_id = nil
       else
@@ -118,14 +128,21 @@ module Vapi
       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
+      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,
         voice_id: voice_id,
         speed: speed,
         temperature: temperature,
@@ -133,7 +150,10 @@ module Vapi
         voice_guidance: voice_guidance,
         style_guidance: style_guidance,
         text_guidance: text_guidance,
+        model: model,
+        language: language,
         chunk_plan: chunk_plan,
+        fallback_plan: fallback_plan,
         additional_properties: struct
       )
     end
@@ -152,7 +172,6 @@ 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.")
       Vapi::PlayHtVoiceId.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.")
@@ -160,7 +179,10 @@ module Vapi
       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::PlayHtVoiceModel) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
+      obj.language&.is_a?(Vapi::PlayHtVoiceLanguage) != 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)
+      obj.fallback_plan.nil? || Vapi::FallbackPlan.validate_raw(obj: obj.fallback_plan)
     end
   end
 end

data/lib/vapi_server_sdk/types/play_ht_voice_language.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Vapi
+  # The language to use for the speech.
+  class PlayHtVoiceLanguage
+    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/play_ht_voice_model.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Vapi
+  # Playht voice model/engine to use.
+  class PlayHtVoiceModel
+    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/regex_option.rb

@@ -7,7 +7,7 @@ require "json"
 module Vapi
   class RegexOption
     # @return [Vapi::RegexOptionType] This is the type of the regex option. Options are:
-    #  - `ignore-case`: Ignores the case of the text being matched.
+    #  - `ignore-case`: Ignores the case of the text being matched. Add
     #  - `whole-word`: Matches whole words only.
     #  - `multi-line`: Matches across multiple lines.
     attr_reader :type
@@ -23,7 +23,7 @@ module Vapi
     OMIT = Object.new
 
     # @param type [Vapi::RegexOptionType] This is the type of the regex option. Options are:
-    #  - `ignore-case`: Ignores the case of the text being matched.
+    #  - `ignore-case`: Ignores the case of the text being matched. Add
     #  - `whole-word`: Matches whole words only.
     #  - `multi-line`: Matches across multiple lines.
     # @param enabled [Boolean] This is whether to enable the option.

data/lib/vapi_server_sdk/types/regex_option_type.rb

@@ -2,7 +2,7 @@
 
 module Vapi
   # This is the type of the regex option. Options are:
-  #  - `ignore-case`: Ignores the case of the text being matched.
+  #  - `ignore-case`: Ignores the case of the text being matched. Add
   #  - `whole-word`: Matches whole words only.
   #  - `multi-line`: Matches across multiple lines.
   class RegexOptionType

data/lib/vapi_server_sdk/types/regex_replacement.rb

@@ -7,9 +7,14 @@ require "json"
 module Vapi
   class RegexReplacement
     # @return [String] This is the regex pattern to replace.
+    #  Note:
+    #  - This works by using the `string.replace` method in Node.JS. Eg. `"hello
+    #  there".replace(/hello/g, "hi")` will return `"hi there"`.
+    #  Hot tip:
+    #  - In JavaScript, escape `\` when sending the regex pattern. Eg. `"hello\sthere"`
+    #  will be sent over the wire as `"hellosthere"`. Send `"hello\\sthere"` instead.
     attr_reader :regex
-    # @return [Array<Vapi::RegexOption>] These are the options for the regex replacement. Default all options are
-    #  disabled.
+    # @return [Array<Vapi::RegexOption>] These are the options for the regex replacement. Defaults to all disabled.
     #  @default []
     attr_reader :options
     # @return [String] This is the value that will replace the match.
@@ -23,8 +28,13 @@ module Vapi
     OMIT = Object.new
 
     # @param regex [String] This is the regex pattern to replace.
-    # @param options [Array<Vapi::RegexOption>] These are the options for the regex replacement. Default all options are
-    #  disabled.
+    #  Note:
+    #  - This works by using the `string.replace` method in Node.JS. Eg. `"hello
+    #  there".replace(/hello/g, "hi")` will return `"hi there"`.
+    #  Hot tip:
+    #  - In JavaScript, escape `\` when sending the regex pattern. Eg. `"hello\sthere"`
+    #  will be sent over the wire as `"hellosthere"`. Send `"hello\\sthere"` instead.
+    # @param options [Array<Vapi::RegexOption>] These are the options for the regex replacement. Defaults to all disabled.
     #  @default []
     # @param value [String] This is the value that will replace the match.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition