vapi_server_sdk 0.5.0 → 0.9.1

data/lib/vapi_server_sdk/types/server_message_user_interrupted_phone_number.rb

@@ -5,12 +5,10 @@ require_relative "create_byo_phone_number_dto"
 require_relative "create_twilio_phone_number_dto"
 require_relative "create_vonage_phone_number_dto"
 require_relative "create_vapi_phone_number_dto"
+require_relative "create_telnyx_phone_number_dto"
 
 module Vapi
-  # This is the phone number associated with the call.
-  #  This matches one of the following:
-  #  - `call.phoneNumber`,
-  #  - `call.phoneNumberId`.
+  # This is the phone number that the message is associated with.
   class ServerMessageUserInterruptedPhoneNumber
     # @return [Object]
     attr_reader :member
@@ -44,6 +42,8 @@ module Vapi
                  Vapi::CreateVonagePhoneNumberDto.from_json(json_object: json_object)
                when "vapi"
                  Vapi::CreateVapiPhoneNumberDto.from_json(json_object: json_object)
+               when "telnyx"
+                 Vapi::CreateTelnyxPhoneNumberDto.from_json(json_object: json_object)
                else
                  Vapi::CreateByoPhoneNumberDto.from_json(json_object: json_object)
                end
@@ -63,6 +63,8 @@ module Vapi
         { **@member.to_json, provider: @discriminant }.to_json
       when "vapi"
         { **@member.to_json, provider: @discriminant }.to_json
+      when "telnyx"
+        { **@member.to_json, provider: @discriminant }.to_json
       else
         { "provider": @discriminant, value: @member }.to_json
       end
@@ -85,6 +87,8 @@ module Vapi
         Vapi::CreateVonagePhoneNumberDto.validate_raw(obj: obj)
       when "vapi"
         Vapi::CreateVapiPhoneNumberDto.validate_raw(obj: obj)
+      when "telnyx"
+        Vapi::CreateTelnyxPhoneNumberDto.validate_raw(obj: obj)
       else
         raise("Passed value matched no type within the union, validation failed.")
       end
@@ -121,5 +125,11 @@ module Vapi
     def self.vapi(member:)
       new(member: member, discriminant: "vapi")
     end
+
+    # @param member [Vapi::CreateTelnyxPhoneNumberDto]
+    # @return [Vapi::ServerMessageUserInterruptedPhoneNumber]
+    def self.telnyx(member:)
+      new(member: member, discriminant: "telnyx")
+    end
   end
 end

data/lib/vapi_server_sdk/types/server_message_voice_input.rb

@@ -5,44 +5,27 @@ require_relative "artifact"
 require_relative "create_assistant_dto"
 require_relative "create_customer_dto"
 require_relative "call"
+require_relative "chat"
 require "ostruct"
 require "json"
 
 module Vapi
   class ServerMessageVoiceInput
-    # @return [Vapi::ServerMessageVoiceInputPhoneNumber] This is the phone number associated with the call.
-    #  This matches one of the following:
-    #  - `call.phoneNumber`,
-    #  - `call.phoneNumberId`.
+    # @return [Vapi::ServerMessageVoiceInputPhoneNumber] This is the phone number that the message is associated with.
     attr_reader :phone_number
-    # @return [String] This is the type of the message. "voice-input" is sent when a generation is
-    #  requested from voice provider.
-    attr_reader :type
-    # @return [String] This is the ISO-8601 formatted timestamp of when the message was sent.
+    # @return [Float] This is the timestamp of the message.
     attr_reader :timestamp
     # @return [Vapi::Artifact] This is a live version of the `call.artifact`.
     #  This matches what is stored on `call.artifact` after the call.
     attr_reader :artifact
-    # @return [Vapi::CreateAssistantDto] This is the assistant that is currently active. This is provided for
-    #  convenience.
-    #  This matches one of the following:
-    #  - `call.assistant`,
-    #  - `call.assistantId`,
-    #  - `call.squad[n].assistant`,
-    #  - `call.squad[n].assistantId`,
-    #  - `call.squadId->[n].assistant`,
-    #  - `call.squadId->[n].assistantId`.
+    # @return [Vapi::CreateAssistantDto] This is the assistant that the message is associated with.
     attr_reader :assistant
-    # @return [Vapi::CreateCustomerDto] This is the customer associated with the call.
-    #  This matches one of the following:
-    #  - `call.customer`,
-    #  - `call.customerId`.
+    # @return [Vapi::CreateCustomerDto] This is the customer that the message is associated with.
     attr_reader :customer
-    # @return [Vapi::Call] This is the call object.
-    #  This matches what was returned in POST /call.
-    #  Note: This might get stale during the call. To get the latest call object,
-    #  especially after the call is ended, use GET /call/:id.
+    # @return [Vapi::Call] This is the call that the message is associated with.
     attr_reader :call
+    # @return [Vapi::Chat] This is the chat object.
+    attr_reader :chat
     # @return [String] This is the voice input content
     attr_reader :input
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -53,54 +36,36 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param phone_number [Vapi::ServerMessageVoiceInputPhoneNumber] This is the phone number associated with the call.
-    #  This matches one of the following:
-    #  - `call.phoneNumber`,
-    #  - `call.phoneNumberId`.
-    # @param type [String] This is the type of the message. "voice-input" is sent when a generation is
-    #  requested from voice provider.
-    # @param timestamp [String] This is the ISO-8601 formatted timestamp of when the message was sent.
+    # @param phone_number [Vapi::ServerMessageVoiceInputPhoneNumber] This is the phone number that the message is associated with.
+    # @param timestamp [Float] This is the timestamp of the message.
     # @param artifact [Vapi::Artifact] This is a live version of the `call.artifact`.
     #  This matches what is stored on `call.artifact` after the call.
-    # @param assistant [Vapi::CreateAssistantDto] This is the assistant that is currently active. This is provided for
-    #  convenience.
-    #  This matches one of the following:
-    #  - `call.assistant`,
-    #  - `call.assistantId`,
-    #  - `call.squad[n].assistant`,
-    #  - `call.squad[n].assistantId`,
-    #  - `call.squadId->[n].assistant`,
-    #  - `call.squadId->[n].assistantId`.
-    # @param customer [Vapi::CreateCustomerDto] This is the customer associated with the call.
-    #  This matches one of the following:
-    #  - `call.customer`,
-    #  - `call.customerId`.
-    # @param call [Vapi::Call] This is the call object.
-    #  This matches what was returned in POST /call.
-    #  Note: This might get stale during the call. To get the latest call object,
-    #  especially after the call is ended, use GET /call/:id.
+    # @param assistant [Vapi::CreateAssistantDto] This is the assistant that the message is associated with.
+    # @param customer [Vapi::CreateCustomerDto] This is the customer that the message is associated with.
+    # @param call [Vapi::Call] This is the call that the message is associated with.
+    # @param chat [Vapi::Chat] This is the chat object.
     # @param input [String] This is the voice input content
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ServerMessageVoiceInput]
-    def initialize(type:, input:, phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT,
-                   call: OMIT, additional_properties: nil)
+    def initialize(input:, phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT, call: OMIT,
+                   chat: OMIT, additional_properties: nil)
       @phone_number = phone_number if phone_number != OMIT
-      @type = type
       @timestamp = timestamp if timestamp != OMIT
       @artifact = artifact if artifact != OMIT
       @assistant = assistant if assistant != OMIT
       @customer = customer if customer != OMIT
       @call = call if call != OMIT
+      @chat = chat if chat != OMIT
       @input = input
       @additional_properties = additional_properties
       @_field_set = {
         "phoneNumber": phone_number,
-        "type": type,
         "timestamp": timestamp,
         "artifact": artifact,
         "assistant": assistant,
         "customer": customer,
         "call": call,
+        "chat": chat,
         "input": input
       }.reject do |_k, v|
         v == OMIT
@@ -120,7 +85,6 @@ module Vapi
         phone_number = parsed_json["phoneNumber"].to_json
         phone_number = Vapi::ServerMessageVoiceInputPhoneNumber.from_json(json_object: phone_number)
       end
-      type = parsed_json["type"]
       timestamp = parsed_json["timestamp"]
       if parsed_json["artifact"].nil?
         artifact = nil
@@ -146,15 +110,21 @@ module Vapi
         call = parsed_json["call"].to_json
         call = Vapi::Call.from_json(json_object: call)
       end
+      if parsed_json["chat"].nil?
+        chat = nil
+      else
+        chat = parsed_json["chat"].to_json
+        chat = Vapi::Chat.from_json(json_object: chat)
+      end
       input = parsed_json["input"]
       new(
         phone_number: phone_number,
-        type: type,
         timestamp: timestamp,
         artifact: artifact,
         assistant: assistant,
         customer: customer,
         call: call,
+        chat: chat,
         input: input,
         additional_properties: struct
       )
@@ -175,12 +145,12 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.phone_number.nil? || Vapi::ServerMessageVoiceInputPhoneNumber.validate_raw(obj: obj.phone_number)
-      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
-      obj.timestamp&.is_a?(String) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
+      obj.timestamp&.is_a?(Float) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
       obj.artifact.nil? || Vapi::Artifact.validate_raw(obj: obj.artifact)
       obj.assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.assistant)
       obj.customer.nil? || Vapi::CreateCustomerDto.validate_raw(obj: obj.customer)
       obj.call.nil? || Vapi::Call.validate_raw(obj: obj.call)
+      obj.chat.nil? || Vapi::Chat.validate_raw(obj: obj.chat)
       obj.input.is_a?(String) != false || raise("Passed value for field obj.input is not the expected type, validation failed.")
     end
   end

data/lib/vapi_server_sdk/types/server_message_voice_input_phone_number.rb

@@ -5,12 +5,10 @@ require_relative "create_byo_phone_number_dto"
 require_relative "create_twilio_phone_number_dto"
 require_relative "create_vonage_phone_number_dto"
 require_relative "create_vapi_phone_number_dto"
+require_relative "create_telnyx_phone_number_dto"
 
 module Vapi
-  # This is the phone number associated with the call.
-  #  This matches one of the following:
-  #  - `call.phoneNumber`,
-  #  - `call.phoneNumberId`.
+  # This is the phone number that the message is associated with.
   class ServerMessageVoiceInputPhoneNumber
     # @return [Object]
     attr_reader :member
@@ -43,6 +41,8 @@ module Vapi
                  Vapi::CreateVonagePhoneNumberDto.from_json(json_object: json_object)
                when "vapi"
                  Vapi::CreateVapiPhoneNumberDto.from_json(json_object: json_object)
+               when "telnyx"
+                 Vapi::CreateTelnyxPhoneNumberDto.from_json(json_object: json_object)
                else
                  Vapi::CreateByoPhoneNumberDto.from_json(json_object: json_object)
                end
@@ -62,6 +62,8 @@ module Vapi
         { **@member.to_json, provider: @discriminant }.to_json
       when "vapi"
         { **@member.to_json, provider: @discriminant }.to_json
+      when "telnyx"
+        { **@member.to_json, provider: @discriminant }.to_json
       else
         { "provider": @discriminant, value: @member }.to_json
       end
@@ -84,6 +86,8 @@ module Vapi
         Vapi::CreateVonagePhoneNumberDto.validate_raw(obj: obj)
       when "vapi"
         Vapi::CreateVapiPhoneNumberDto.validate_raw(obj: obj)
+      when "telnyx"
+        Vapi::CreateTelnyxPhoneNumberDto.validate_raw(obj: obj)
       else
         raise("Passed value matched no type within the union, validation failed.")
       end
@@ -120,5 +124,11 @@ module Vapi
     def self.vapi(member:)
       new(member: member, discriminant: "vapi")
     end
+
+    # @param member [Vapi::CreateTelnyxPhoneNumberDto]
+    # @return [Vapi::ServerMessageVoiceInputPhoneNumber]
+    def self.telnyx(member:)
+      new(member: member, discriminant: "telnyx")
+    end
   end
 end

data/lib/vapi_server_sdk/types/server_message_voice_request.rb

@@ -5,63 +5,27 @@ require_relative "artifact"
 require_relative "create_assistant_dto"
 require_relative "create_customer_dto"
 require_relative "call"
+require_relative "chat"
 require "ostruct"
 require "json"
 
 module Vapi
   class ServerMessageVoiceRequest
-    # @return [Vapi::ServerMessageVoiceRequestPhoneNumber] This is the phone number associated with the call.
-    #  This matches one of the following:
-    #  - `call.phoneNumber`,
-    #  - `call.phoneNumberId`.
+    # @return [Vapi::ServerMessageVoiceRequestPhoneNumber] This is the phone number that the message is associated with.
     attr_reader :phone_number
-    # @return [String] This is the type of the message. "voice-request" is sent when using
-    #  `assistant.voice={ "type": "custom-voice" }`.
-    #  Here is what the request will look like:
-    #  POST https://{assistant.voice.server.url}
-    #  Content-Type: application/json
-    #  {
-    #  "messsage": {
-    #  "type": "voice-request",
-    #  "text": "Hello, world!",
-    #  "sampleRate": 24000,
-    #  ...other metadata about the call...
-    #  }
-    #  }
-    #  The expected response is 1-channel 16-bit raw PCM audio at the sample rate
-    #  specified in the request. Here is how the response will be piped to the
-    #  transport:
-    #  ```
-    #  response.on('data', (chunk: Buffer) => {
-    #  outputStream.write(chunk);
-    #  });
-    #  ```
-    attr_reader :type
-    # @return [String] This is the ISO-8601 formatted timestamp of when the message was sent.
+    # @return [Float] This is the timestamp of the message.
     attr_reader :timestamp
     # @return [Vapi::Artifact] This is a live version of the `call.artifact`.
     #  This matches what is stored on `call.artifact` after the call.
     attr_reader :artifact
-    # @return [Vapi::CreateAssistantDto] This is the assistant that is currently active. This is provided for
-    #  convenience.
-    #  This matches one of the following:
-    #  - `call.assistant`,
-    #  - `call.assistantId`,
-    #  - `call.squad[n].assistant`,
-    #  - `call.squad[n].assistantId`,
-    #  - `call.squadId->[n].assistant`,
-    #  - `call.squadId->[n].assistantId`.
+    # @return [Vapi::CreateAssistantDto] This is the assistant that the message is associated with.
     attr_reader :assistant
-    # @return [Vapi::CreateCustomerDto] This is the customer associated with the call.
-    #  This matches one of the following:
-    #  - `call.customer`,
-    #  - `call.customerId`.
+    # @return [Vapi::CreateCustomerDto] This is the customer that the message is associated with.
     attr_reader :customer
-    # @return [Vapi::Call] This is the call object.
-    #  This matches what was returned in POST /call.
-    #  Note: This might get stale during the call. To get the latest call object,
-    #  especially after the call is ended, use GET /call/:id.
+    # @return [Vapi::Call] This is the call that the message is associated with.
     attr_reader :call
+    # @return [Vapi::Chat] This is the chat object.
+    attr_reader :chat
     # @return [String] This is the text to be synthesized.
     attr_reader :text
     # @return [Float] This is the sample rate to be synthesized.
@@ -74,75 +38,38 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param phone_number [Vapi::ServerMessageVoiceRequestPhoneNumber] This is the phone number associated with the call.
-    #  This matches one of the following:
-    #  - `call.phoneNumber`,
-    #  - `call.phoneNumberId`.
-    # @param type [String] This is the type of the message. "voice-request" is sent when using
-    #  `assistant.voice={ "type": "custom-voice" }`.
-    #  Here is what the request will look like:
-    #  POST https://{assistant.voice.server.url}
-    #  Content-Type: application/json
-    #  {
-    #  "messsage": {
-    #  "type": "voice-request",
-    #  "text": "Hello, world!",
-    #  "sampleRate": 24000,
-    #  ...other metadata about the call...
-    #  }
-    #  }
-    #  The expected response is 1-channel 16-bit raw PCM audio at the sample rate
-    #  specified in the request. Here is how the response will be piped to the
-    #  transport:
-    #  ```
-    #  response.on('data', (chunk: Buffer) => {
-    #  outputStream.write(chunk);
-    #  });
-    #  ```
-    # @param timestamp [String] This is the ISO-8601 formatted timestamp of when the message was sent.
+    # @param phone_number [Vapi::ServerMessageVoiceRequestPhoneNumber] This is the phone number that the message is associated with.
+    # @param timestamp [Float] This is the timestamp of the message.
     # @param artifact [Vapi::Artifact] This is a live version of the `call.artifact`.
     #  This matches what is stored on `call.artifact` after the call.
-    # @param assistant [Vapi::CreateAssistantDto] This is the assistant that is currently active. This is provided for
-    #  convenience.
-    #  This matches one of the following:
-    #  - `call.assistant`,
-    #  - `call.assistantId`,
-    #  - `call.squad[n].assistant`,
-    #  - `call.squad[n].assistantId`,
-    #  - `call.squadId->[n].assistant`,
-    #  - `call.squadId->[n].assistantId`.
-    # @param customer [Vapi::CreateCustomerDto] This is the customer associated with the call.
-    #  This matches one of the following:
-    #  - `call.customer`,
-    #  - `call.customerId`.
-    # @param call [Vapi::Call] This is the call object.
-    #  This matches what was returned in POST /call.
-    #  Note: This might get stale during the call. To get the latest call object,
-    #  especially after the call is ended, use GET /call/:id.
+    # @param assistant [Vapi::CreateAssistantDto] This is the assistant that the message is associated with.
+    # @param customer [Vapi::CreateCustomerDto] This is the customer that the message is associated with.
+    # @param call [Vapi::Call] This is the call that the message is associated with.
+    # @param chat [Vapi::Chat] This is the chat object.
     # @param text [String] This is the text to be synthesized.
     # @param sample_rate [Float] This is the sample rate to be synthesized.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ServerMessageVoiceRequest]
-    def initialize(type:, text:, sample_rate:, phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT,
-                   call: OMIT, additional_properties: nil)
+    def initialize(text:, sample_rate:, phone_number: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT, call: OMIT,
+                   chat: OMIT, additional_properties: nil)
       @phone_number = phone_number if phone_number != OMIT
-      @type = type
       @timestamp = timestamp if timestamp != OMIT
       @artifact = artifact if artifact != OMIT
       @assistant = assistant if assistant != OMIT
       @customer = customer if customer != OMIT
       @call = call if call != OMIT
+      @chat = chat if chat != OMIT
       @text = text
       @sample_rate = sample_rate
       @additional_properties = additional_properties
       @_field_set = {
         "phoneNumber": phone_number,
-        "type": type,
         "timestamp": timestamp,
         "artifact": artifact,
         "assistant": assistant,
         "customer": customer,
         "call": call,
+        "chat": chat,
         "text": text,
         "sampleRate": sample_rate
       }.reject do |_k, v|
@@ -163,7 +90,6 @@ module Vapi
         phone_number = parsed_json["phoneNumber"].to_json
         phone_number = Vapi::ServerMessageVoiceRequestPhoneNumber.from_json(json_object: phone_number)
       end
-      type = parsed_json["type"]
       timestamp = parsed_json["timestamp"]
       if parsed_json["artifact"].nil?
         artifact = nil
@@ -189,16 +115,22 @@ module Vapi
         call = parsed_json["call"].to_json
         call = Vapi::Call.from_json(json_object: call)
       end
+      if parsed_json["chat"].nil?
+        chat = nil
+      else
+        chat = parsed_json["chat"].to_json
+        chat = Vapi::Chat.from_json(json_object: chat)
+      end
       text = parsed_json["text"]
       sample_rate = parsed_json["sampleRate"]
       new(
         phone_number: phone_number,
-        type: type,
         timestamp: timestamp,
         artifact: artifact,
         assistant: assistant,
         customer: customer,
         call: call,
+        chat: chat,
         text: text,
         sample_rate: sample_rate,
         additional_properties: struct
@@ -220,12 +152,12 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.phone_number.nil? || Vapi::ServerMessageVoiceRequestPhoneNumber.validate_raw(obj: obj.phone_number)
-      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
-      obj.timestamp&.is_a?(String) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
+      obj.timestamp&.is_a?(Float) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
       obj.artifact.nil? || Vapi::Artifact.validate_raw(obj: obj.artifact)
       obj.assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.assistant)
       obj.customer.nil? || Vapi::CreateCustomerDto.validate_raw(obj: obj.customer)
       obj.call.nil? || Vapi::Call.validate_raw(obj: obj.call)
+      obj.chat.nil? || Vapi::Chat.validate_raw(obj: obj.chat)
       obj.text.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
       obj.sample_rate.is_a?(Float) != false || raise("Passed value for field obj.sample_rate is not the expected type, validation failed.")
     end

data/lib/vapi_server_sdk/types/server_message_voice_request_phone_number.rb

@@ -5,12 +5,10 @@ require_relative "create_byo_phone_number_dto"
 require_relative "create_twilio_phone_number_dto"
 require_relative "create_vonage_phone_number_dto"
 require_relative "create_vapi_phone_number_dto"
+require_relative "create_telnyx_phone_number_dto"
 
 module Vapi
-  # This is the phone number associated with the call.
-  #  This matches one of the following:
-  #  - `call.phoneNumber`,
-  #  - `call.phoneNumberId`.
+  # This is the phone number that the message is associated with.
   class ServerMessageVoiceRequestPhoneNumber
     # @return [Object]
     attr_reader :member
@@ -43,6 +41,8 @@ module Vapi
                  Vapi::CreateVonagePhoneNumberDto.from_json(json_object: json_object)
                when "vapi"
                  Vapi::CreateVapiPhoneNumberDto.from_json(json_object: json_object)
+               when "telnyx"
+                 Vapi::CreateTelnyxPhoneNumberDto.from_json(json_object: json_object)
                else
                  Vapi::CreateByoPhoneNumberDto.from_json(json_object: json_object)
                end
@@ -62,6 +62,8 @@ module Vapi
         { **@member.to_json, provider: @discriminant }.to_json
       when "vapi"
         { **@member.to_json, provider: @discriminant }.to_json
+      when "telnyx"
+        { **@member.to_json, provider: @discriminant }.to_json
       else
         { "provider": @discriminant, value: @member }.to_json
       end
@@ -84,6 +86,8 @@ module Vapi
         Vapi::CreateVonagePhoneNumberDto.validate_raw(obj: obj)
       when "vapi"
         Vapi::CreateVapiPhoneNumberDto.validate_raw(obj: obj)
+      when "telnyx"
+        Vapi::CreateTelnyxPhoneNumberDto.validate_raw(obj: obj)
       else
         raise("Passed value matched no type within the union, validation failed.")
       end
@@ -120,5 +124,11 @@ module Vapi
     def self.vapi(member:)
       new(member: member, discriminant: "vapi")
     end
+
+    # @param member [Vapi::CreateTelnyxPhoneNumberDto]
+    # @return [Vapi::ServerMessageVoiceRequestPhoneNumber]
+    def self.telnyx(member:)
+      new(member: member, discriminant: "telnyx")
+    end
   end
 end

data/lib/vapi_server_sdk/types/sesame_voice.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require_relative "chunk_plan"
+require_relative "fallback_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class SesameVoice
+    # @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 [String] This is the model that will be used.
+    attr_reader :model
+    # @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]
+    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 [String] This is the model 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 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::SesameVoice]
+    def initialize(voice_id:, model:, caching_enabled: OMIT, chunk_plan: OMIT, fallback_plan: OMIT,
+                   additional_properties: nil)
+      @caching_enabled = caching_enabled if caching_enabled != OMIT
+      @voice_id = voice_id
+      @model = model
+      @chunk_plan = chunk_plan if chunk_plan != OMIT
+      @fallback_plan = fallback_plan if fallback_plan != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "cachingEnabled": caching_enabled,
+        "voiceId": voice_id,
+        "model": model,
+        "chunkPlan": chunk_plan,
+        "fallbackPlan": fallback_plan
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of SesameVoice
+    #
+    # @param json_object [String]
+    # @return [Vapi::SesameVoice]
+    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"]
+      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(
+        caching_enabled: caching_enabled,
+        voice_id: voice_id,
+        model: model,
+        chunk_plan: chunk_plan,
+        fallback_plan: fallback_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of SesameVoice 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?(String) != false || raise("Passed value for field obj.model 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