vapi_server_sdk 0.5.0 → 0.9.1

data/lib/vapi_server_sdk/types/transfer_fallback_plan.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative "transfer_fallback_plan_message"
+require "ostruct"
+require "json"
+
+module Vapi
+  class TransferFallbackPlan
+    # @return [Vapi::TransferFallbackPlanMessage] This is the message the assistant will deliver to the customer if the transfer
+    #  fails.
+    attr_reader :message
+    # @return [Boolean] This controls what happens after delivering the failure message to the customer.
+    #  - true: End the call after delivering the failure message (default)
+    #  - false: Keep the assistant on the call to continue handling the customer's
+    #  request
+    #  @default true
+    attr_reader :end_call_enabled
+    # @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 message [Vapi::TransferFallbackPlanMessage] This is the message the assistant will deliver to the customer if the transfer
+    #  fails.
+    # @param end_call_enabled [Boolean] This controls what happens after delivering the failure message to the customer.
+    #  - true: End the call after delivering the failure message (default)
+    #  - false: Keep the assistant on the call to continue handling the customer's
+    #  request
+    #  @default true
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::TransferFallbackPlan]
+    def initialize(message:, end_call_enabled: OMIT, additional_properties: nil)
+      @message = message
+      @end_call_enabled = end_call_enabled if end_call_enabled != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "message": message, "endCallEnabled": end_call_enabled }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of TransferFallbackPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::TransferFallbackPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["message"].nil?
+        message = nil
+      else
+        message = parsed_json["message"].to_json
+        message = Vapi::TransferFallbackPlanMessage.from_json(json_object: message)
+      end
+      end_call_enabled = parsed_json["endCallEnabled"]
+      new(
+        message: message,
+        end_call_enabled: end_call_enabled,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of TransferFallbackPlan to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      Vapi::TransferFallbackPlanMessage.validate_raw(obj: obj.message)
+      obj.end_call_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.end_call_enabled is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/{fallback_neets_voice_id.rb → transfer_fallback_plan_message.rb}

@@ -1,18 +1,20 @@
 # frozen_string_literal: true
 
 require "json"
+require_relative "custom_message"
 
 module Vapi
-  # This is the provider-specific ID that will be used.
-  class FallbackNeetsVoiceId
-    # Deserialize a JSON object to an instance of FallbackNeetsVoiceId
+  # This is the message the assistant will deliver to the customer if the transfer
+  #  fails.
+  class TransferFallbackPlanMessage
+    # Deserialize a JSON object to an instance of TransferFallbackPlanMessage
     #
     # @param json_object [String]
-    # @return [Vapi::FallbackNeetsVoiceId]
+    # @return [Vapi::TransferFallbackPlanMessage]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       begin
-        struct.is_a?(Vapi::FallbackNeetsVoiceIdEnum) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+        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
@@ -20,8 +22,8 @@ module Vapi
         # 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?
+        Vapi::CustomMessage.validate_raw(obj: struct)
+        return Vapi::CustomMessage.from_json(json_object: struct) unless struct.nil?
 
         return nil
       rescue StandardError
@@ -38,12 +40,12 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       begin
-        return obj.is_a?(Vapi::FallbackNeetsVoiceIdEnum) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+        return obj.is_a?(String) != 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.")
+        return Vapi::CustomMessage.validate_raw(obj: obj)
       rescue StandardError
         # noop
       end

data/lib/vapi_server_sdk/types/transfer_phone_number_hook_action.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "transfer_phone_number_hook_action_destination"
+require "ostruct"
+require "json"
+
+module Vapi
+  class TransferPhoneNumberHookAction
+    # @return [Vapi::TransferPhoneNumberHookActionDestination] This is the destination details for the transfer - can be a phone number or SIP
+    #  URI
+    attr_reader :destination
+    # @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 destination [Vapi::TransferPhoneNumberHookActionDestination] This is the destination details for the transfer - can be a phone number or SIP
+    #  URI
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::TransferPhoneNumberHookAction]
+    def initialize(destination: OMIT, additional_properties: nil)
+      @destination = destination if destination != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "destination": destination }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of TransferPhoneNumberHookAction
+    #
+    # @param json_object [String]
+    # @return [Vapi::TransferPhoneNumberHookAction]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["destination"].nil?
+        destination = nil
+      else
+        destination = parsed_json["destination"].to_json
+        destination = Vapi::TransferPhoneNumberHookActionDestination.from_json(json_object: destination)
+      end
+      new(destination: destination, additional_properties: struct)
+    end
+
+    # Serialize an instance of TransferPhoneNumberHookAction 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.destination.nil? || Vapi::TransferPhoneNumberHookActionDestination.validate_raw(obj: obj.destination)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/{create_trieve_knowledge_base_dto_create_plan.rb → transfer_phone_number_hook_action_destination.rb}

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 require "json"
-require_relative "trieve_knowledge_base_create"
-require_relative "trieve_knowledge_base_import"
+require_relative "transfer_destination_number"
+require_relative "transfer_destination_sip"
 
 module Vapi
-  # This is the plan if you want us to create/import a new vector store using
-  #  Trieve.
-  class CreateTrieveKnowledgeBaseDtoCreatePlan
+  # This is the destination details for the transfer - can be a phone number or SIP
+  #  URI
+  class TransferPhoneNumberHookActionDestination
     # @return [Object]
     attr_reader :member
     # @return [String]
@@ -18,26 +18,26 @@ module Vapi
 
     # @param member [Object]
     # @param discriminant [String]
-    # @return [Vapi::CreateTrieveKnowledgeBaseDtoCreatePlan]
+    # @return [Vapi::TransferPhoneNumberHookActionDestination]
     def initialize(member:, discriminant:)
       @member = member
       @discriminant = discriminant
     end
 
     # Deserialize a JSON object to an instance of
-    #  CreateTrieveKnowledgeBaseDtoCreatePlan
+    #  TransferPhoneNumberHookActionDestination
     #
     # @param json_object [String]
-    # @return [Vapi::CreateTrieveKnowledgeBaseDtoCreatePlan]
+    # @return [Vapi::TransferPhoneNumberHookActionDestination]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       member = case struct.type
-               when "create"
-                 Vapi::TrieveKnowledgeBaseCreate.from_json(json_object: json_object)
-               when "import"
-                 Vapi::TrieveKnowledgeBaseImport.from_json(json_object: json_object)
+               when "number"
+                 Vapi::TransferDestinationNumber.from_json(json_object: json_object)
+               when "sip"
+                 Vapi::TransferDestinationSip.from_json(json_object: json_object)
                else
-                 Vapi::TrieveKnowledgeBaseCreate.from_json(json_object: json_object)
+                 Vapi::TransferDestinationNumber.from_json(json_object: json_object)
                end
       new(member: member, discriminant: struct.type)
     end
@@ -47,9 +47,9 @@ module Vapi
     # @return [String]
     def to_json(*_args)
       case @discriminant
-      when "create"
+      when "number"
         { **@member.to_json, type: @discriminant }.to_json
-      when "import"
+      when "sip"
         { **@member.to_json, type: @discriminant }.to_json
       else
         { "type": @discriminant, value: @member }.to_json
@@ -65,10 +65,10 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       case obj.type
-      when "create"
-        Vapi::TrieveKnowledgeBaseCreate.validate_raw(obj: obj)
-      when "import"
-        Vapi::TrieveKnowledgeBaseImport.validate_raw(obj: obj)
+      when "number"
+        Vapi::TransferDestinationNumber.validate_raw(obj: obj)
+      when "sip"
+        Vapi::TransferDestinationSip.validate_raw(obj: obj)
       else
         raise("Passed value matched no type within the union, validation failed.")
       end
@@ -82,16 +82,16 @@ module Vapi
       @member.is_a?(obj)
     end
 
-    # @param member [Vapi::TrieveKnowledgeBaseCreate]
-    # @return [Vapi::CreateTrieveKnowledgeBaseDtoCreatePlan]
-    def self.create(member:)
-      new(member: member, discriminant: "create")
+    # @param member [Vapi::TransferDestinationNumber]
+    # @return [Vapi::TransferPhoneNumberHookActionDestination]
+    def self.number(member:)
+      new(member: member, discriminant: "number")
     end
 
-    # @param member [Vapi::TrieveKnowledgeBaseImport]
-    # @return [Vapi::CreateTrieveKnowledgeBaseDtoCreatePlan]
-    def self.import(member:)
-      new(member: member, discriminant: "import")
+    # @param member [Vapi::TransferDestinationSip]
+    # @return [Vapi::TransferPhoneNumberHookActionDestination]
+    def self.sip(member:)
+      new(member: member, discriminant: "sip")
     end
   end
 end

data/lib/vapi_server_sdk/types/transfer_plan.rb

@@ -3,6 +3,7 @@
 require_relative "transfer_plan_mode"
 require_relative "transfer_plan_message"
 require_relative "summary_plan"
+require_relative "transfer_fallback_plan"
 require "ostruct"
 require "json"
 
@@ -30,19 +31,49 @@ module Vapi
     #  - `warm-transfer-twiml`: The assistant dials the destination, executes the twiml
     #  instructions on the destination call leg, connects the customer, and leaves the
     #  call.
+    #  - `warm-transfer-experimental`: The assistant puts the customer on hold, dials
+    #  the destination, and if the destination answers (and is human), delivers a
+    #  message or summary before connecting the customer. If the destination is
+    #  unreachable or not human (e.g., with voicemail detection), the assistant
+    #  delivers the `fallbackMessage` to the customer and optionally ends the call.
     #  @default 'blind-transfer'
     attr_reader :mode
     # @return [Vapi::TransferPlanMessage] This is the message the assistant will deliver to the destination party before
     #  connecting the customer.
     #  Usage:
     #  - Used only when `mode` is `blind-transfer-add-summary-to-sip-header`,
-    #  `warm-transfer-say-message` or
-    #  `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`.
+    #  `warm-transfer-say-message`,
+    #  `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or
+    #  `warm-transfer-experimental`.
     attr_reader :message
+    # @return [Float] This is the timeout in seconds for the
+    #  warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary
+    #  @default 60
+    attr_reader :timeout
     # @return [Hash{String => Object}] This specifies the SIP verb to use while transferring the call.
     #  - 'refer': Uses SIP REFER to transfer the call (default)
     #  - 'bye': Ends current call with SIP BYE
+    #  - 'dial': Uses SIP DIAL to transfer the call
     attr_reader :sip_verb
+    # @return [String] This is the URL to an audio file played while the customer is on hold during
+    #  transfer.
+    #  Usage:
+    #  - Used only when `mode` is `warm-transfer-experimental`.
+    #  - Used when transferring calls to play hold audio for the customer.
+    #  - Must be a publicly accessible URL to an audio file.
+    #  - Supported formats: MP3 and WAV.
+    #  - If not provided, the default hold audio will be used.
+    attr_reader :hold_audio_url
+    # @return [String] This is the URL to an audio file played after the warm transfer message or
+    #  summary is delivered to the destination party.
+    #  It can be used to play a custom sound like 'beep' to notify that the transfer is
+    #  complete.
+    #  Usage:
+    #  - Used only when `mode` is `warm-transfer-experimental`.
+    #  - Used when transferring calls to play hold audio for the destination party.
+    #  - Must be a publicly accessible URL to an audio file.
+    #  - Supported formats: MP3 and WAV.
+    attr_reader :transfer_complete_audio_url
     # @return [String] This is the TwiML instructions to execute on the destination call leg before
     #  connecting the customer.
     #  Usage:
@@ -61,8 +92,20 @@ module Vapi
     #  Usage:
     #  - Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or
     #  `warm-transfer-say-summary` or
-    #  `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`.
+    #  `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or
+    #  `warm-transfer-experimental`.
     attr_reader :summary_plan
+    # @return [Boolean] This flag includes the sipHeaders from above in the refer to sip uri as url
+    #  encoded query params.
+    #  @default false
+    attr_reader :sip_headers_in_refer_to_enabled
+    # @return [Vapi::TransferFallbackPlan] This configures the fallback plan when the transfer fails (destination
+    #  unreachable, busy, or not human).
+    #  Usage:
+    #  - Used only when `mode` is `warm-transfer-experimental`.
+    #  - If not provided when using `warm-transfer-experimental`, a default message
+    #  will be used.
+    attr_reader :fallback_plan
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -93,16 +136,43 @@ module Vapi
     #  - `warm-transfer-twiml`: The assistant dials the destination, executes the twiml
     #  instructions on the destination call leg, connects the customer, and leaves the
     #  call.
+    #  - `warm-transfer-experimental`: The assistant puts the customer on hold, dials
+    #  the destination, and if the destination answers (and is human), delivers a
+    #  message or summary before connecting the customer. If the destination is
+    #  unreachable or not human (e.g., with voicemail detection), the assistant
+    #  delivers the `fallbackMessage` to the customer and optionally ends the call.
     #  @default 'blind-transfer'
     # @param message [Vapi::TransferPlanMessage] This is the message the assistant will deliver to the destination party before
     #  connecting the customer.
     #  Usage:
     #  - Used only when `mode` is `blind-transfer-add-summary-to-sip-header`,
-    #  `warm-transfer-say-message` or
-    #  `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`.
+    #  `warm-transfer-say-message`,
+    #  `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or
+    #  `warm-transfer-experimental`.
+    # @param timeout [Float] This is the timeout in seconds for the
+    #  warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary
+    #  @default 60
     # @param sip_verb [Hash{String => Object}] This specifies the SIP verb to use while transferring the call.
     #  - 'refer': Uses SIP REFER to transfer the call (default)
     #  - 'bye': Ends current call with SIP BYE
+    #  - 'dial': Uses SIP DIAL to transfer the call
+    # @param hold_audio_url [String] This is the URL to an audio file played while the customer is on hold during
+    #  transfer.
+    #  Usage:
+    #  - Used only when `mode` is `warm-transfer-experimental`.
+    #  - Used when transferring calls to play hold audio for the customer.
+    #  - Must be a publicly accessible URL to an audio file.
+    #  - Supported formats: MP3 and WAV.
+    #  - If not provided, the default hold audio will be used.
+    # @param transfer_complete_audio_url [String] This is the URL to an audio file played after the warm transfer message or
+    #  summary is delivered to the destination party.
+    #  It can be used to play a custom sound like 'beep' to notify that the transfer is
+    #  complete.
+    #  Usage:
+    #  - Used only when `mode` is `warm-transfer-experimental`.
+    #  - Used when transferring calls to play hold audio for the destination party.
+    #  - Must be a publicly accessible URL to an audio file.
+    #  - Supported formats: MP3 and WAV.
     # @param twiml [String] This is the TwiML instructions to execute on the destination call leg before
     #  connecting the customer.
     #  Usage:
@@ -120,22 +190,43 @@ module Vapi
     #  Usage:
     #  - Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or
     #  `warm-transfer-say-summary` or
-    #  `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`.
+    #  `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or
+    #  `warm-transfer-experimental`.
+    # @param sip_headers_in_refer_to_enabled [Boolean] This flag includes the sipHeaders from above in the refer to sip uri as url
+    #  encoded query params.
+    #  @default false
+    # @param fallback_plan [Vapi::TransferFallbackPlan] This configures the fallback plan when the transfer fails (destination
+    #  unreachable, busy, or not human).
+    #  Usage:
+    #  - Used only when `mode` is `warm-transfer-experimental`.
+    #  - If not provided when using `warm-transfer-experimental`, a default message
+    #  will be used.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::TransferPlan]
-    def initialize(mode:, message: OMIT, sip_verb: OMIT, twiml: OMIT, summary_plan: OMIT, additional_properties: nil)
+    def initialize(mode:, message: OMIT, timeout: OMIT, sip_verb: OMIT, hold_audio_url: OMIT,
+                   transfer_complete_audio_url: OMIT, twiml: OMIT, summary_plan: OMIT, sip_headers_in_refer_to_enabled: OMIT, fallback_plan: OMIT, additional_properties: nil)
       @mode = mode
       @message = message if message != OMIT
+      @timeout = timeout if timeout != OMIT
       @sip_verb = sip_verb if sip_verb != OMIT
+      @hold_audio_url = hold_audio_url if hold_audio_url != OMIT
+      @transfer_complete_audio_url = transfer_complete_audio_url if transfer_complete_audio_url != OMIT
       @twiml = twiml if twiml != OMIT
       @summary_plan = summary_plan if summary_plan != OMIT
+      @sip_headers_in_refer_to_enabled = sip_headers_in_refer_to_enabled if sip_headers_in_refer_to_enabled != OMIT
+      @fallback_plan = fallback_plan if fallback_plan != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "mode": mode,
         "message": message,
+        "timeout": timeout,
         "sipVerb": sip_verb,
+        "holdAudioUrl": hold_audio_url,
+        "transferCompleteAudioUrl": transfer_complete_audio_url,
         "twiml": twiml,
-        "summaryPlan": summary_plan
+        "summaryPlan": summary_plan,
+        "sipHeadersInReferToEnabled": sip_headers_in_refer_to_enabled,
+        "fallbackPlan": fallback_plan
       }.reject do |_k, v|
         v == OMIT
       end
@@ -155,7 +246,10 @@ module Vapi
         message = parsed_json["message"].to_json
         message = Vapi::TransferPlanMessage.from_json(json_object: message)
       end
+      timeout = parsed_json["timeout"]
       sip_verb = parsed_json["sipVerb"]
+      hold_audio_url = parsed_json["holdAudioUrl"]
+      transfer_complete_audio_url = parsed_json["transferCompleteAudioUrl"]
       twiml = parsed_json["twiml"]
       if parsed_json["summaryPlan"].nil?
         summary_plan = nil
@@ -163,12 +257,24 @@ module Vapi
         summary_plan = parsed_json["summaryPlan"].to_json
         summary_plan = Vapi::SummaryPlan.from_json(json_object: summary_plan)
       end
+      sip_headers_in_refer_to_enabled = parsed_json["sipHeadersInReferToEnabled"]
+      if parsed_json["fallbackPlan"].nil?
+        fallback_plan = nil
+      else
+        fallback_plan = parsed_json["fallbackPlan"].to_json
+        fallback_plan = Vapi::TransferFallbackPlan.from_json(json_object: fallback_plan)
+      end
       new(
         mode: mode,
         message: message,
+        timeout: timeout,
         sip_verb: sip_verb,
+        hold_audio_url: hold_audio_url,
+        transfer_complete_audio_url: transfer_complete_audio_url,
         twiml: twiml,
         summary_plan: summary_plan,
+        sip_headers_in_refer_to_enabled: sip_headers_in_refer_to_enabled,
+        fallback_plan: fallback_plan,
         additional_properties: struct
       )
     end
@@ -189,9 +295,14 @@ module Vapi
     def self.validate_raw(obj:)
       obj.mode.is_a?(Vapi::TransferPlanMode) != false || raise("Passed value for field obj.mode is not the expected type, validation failed.")
       obj.message.nil? || Vapi::TransferPlanMessage.validate_raw(obj: obj.message)
+      obj.timeout&.is_a?(Float) != false || raise("Passed value for field obj.timeout is not the expected type, validation failed.")
       obj.sip_verb&.is_a?(Hash) != false || raise("Passed value for field obj.sip_verb is not the expected type, validation failed.")
+      obj.hold_audio_url&.is_a?(String) != false || raise("Passed value for field obj.hold_audio_url is not the expected type, validation failed.")
+      obj.transfer_complete_audio_url&.is_a?(String) != false || raise("Passed value for field obj.transfer_complete_audio_url is not the expected type, validation failed.")
       obj.twiml&.is_a?(String) != false || raise("Passed value for field obj.twiml is not the expected type, validation failed.")
       obj.summary_plan.nil? || Vapi::SummaryPlan.validate_raw(obj: obj.summary_plan)
+      obj.sip_headers_in_refer_to_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.sip_headers_in_refer_to_enabled is not the expected type, validation failed.")
+      obj.fallback_plan.nil? || Vapi::TransferFallbackPlan.validate_raw(obj: obj.fallback_plan)
     end
   end
 end

data/lib/vapi_server_sdk/types/transfer_plan_message.rb

@@ -8,8 +8,9 @@ module Vapi
   #  connecting the customer.
   #  Usage:
   #  - Used only when `mode` is `blind-transfer-add-summary-to-sip-header`,
-  #  `warm-transfer-say-message` or
-  #  `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`.
+  #  `warm-transfer-say-message`,
+  #  `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or
+  #  `warm-transfer-experimental`.
   class TransferPlanMessage
     # Deserialize a JSON object to an instance of TransferPlanMessage
     #

data/lib/vapi_server_sdk/types/transfer_plan_mode.rb

@@ -23,6 +23,11 @@ module Vapi
   #  - `warm-transfer-twiml`: The assistant dials the destination, executes the twiml
   #  instructions on the destination call leg, connects the customer, and leaves the
   #  call.
+  #  - `warm-transfer-experimental`: The assistant puts the customer on hold, dials
+  #  the destination, and if the destination answers (and is human), delivers a
+  #  message or summary before connecting the customer. If the destination is
+  #  unreachable or not human (e.g., with voicemail detection), the assistant
+  #  delivers the `fallbackMessage` to the customer and optionally ends the call.
   #  @default 'blind-transfer'
   class TransferPlanMode
     BLIND_TRANSFER = "blind-transfer"
@@ -32,5 +37,6 @@ module Vapi
     WARM_TRANSFER_TWIML = "warm-transfer-twiml"
     WARM_TRANSFER_WAIT_FOR_OPERATOR_TO_SPEAK_FIRST_AND_THEN_SAY_MESSAGE = "warm-transfer-wait-for-operator-to-speak-first-and-then-say-message"
     WARM_TRANSFER_WAIT_FOR_OPERATOR_TO_SPEAK_FIRST_AND_THEN_SAY_SUMMARY = "warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary"
+    WARM_TRANSFER_EXPERIMENTAL = "warm-transfer-experimental"
   end
 end

data/lib/vapi_server_sdk/types/trieve_credential.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class TrieveCredential
+    # @return [String]
+    attr_reader :provider
+    # @return [String] This is not returned in the API.
+    attr_reader :api_key
+    # @return [String] This is the unique identifier for the credential.
+    attr_reader :id
+    # @return [String] This is the unique identifier for the org that this credential belongs to.
+    attr_reader :org_id
+    # @return [DateTime] This is the ISO 8601 date-time string of when the credential was created.
+    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 [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 provider [String]
+    # @param api_key [String] This is not returned in the API.
+    # @param id [String] This is the unique identifier for the credential.
+    # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::TrieveCredential]
+    def initialize(provider:, api_key:, id:, org_id:, created_at:, updated_at:, 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
+      @additional_properties = additional_properties
+      @_field_set = {
+        "provider": provider,
+        "apiKey": api_key,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at,
+        "name": name
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of TrieveCredential
+    #
+    # @param json_object [String]
+    # @return [Vapi::TrieveCredential]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      provider = parsed_json["provider"]
+      api_key = parsed_json["apiKey"]
+      id = parsed_json["id"]
+      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"]
+      new(
+        provider: provider,
+        api_key: api_key,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of TrieveCredential 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.provider.is_a?(String) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
+      obj.api_key.is_a?(String) != false || raise("Passed value for field obj.api_key is not the expected type, validation failed.")
+      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      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.")
+    end
+  end
+end