vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/livekit_smart_endpointing_plan.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative "livekit_smart_endpointing_plan_provider"
+require "ostruct"
+require "json"
+
+module Vapi
+  class LivekitSmartEndpointingPlan
+    # @return [Vapi::LivekitSmartEndpointingPlanProvider] This is the provider for the smart endpointing plan.
+    attr_reader :provider
+    # @return [String] This expression describes how long the bot will wait to start speaking based on
+    #  the likelihood that the user has reached an endpoint.
+    #  This is a millisecond valued function. It maps probabilities (real numbers on
+    #  [0,1]) to milliseconds that the bot should wait before speaking ([0, \infty]).
+    #  Any negative values that are returned are set to zero (the bot can't start
+    #  talking in the past).
+    #  A probability of zero represents very high confidence that the caller has
+    #  stopped speaking, and would like the bot to speak to them. A probability of one
+    #  represents very high confidence that the caller is still speaking.
+    #  Under the hood, this is parsed into a mathjs expression. Whatever you use to
+    #  write your expression needs to be valid with respect to mathjs
+    #  @default "20 + 500 * sqrt(x) + 2500 * x^3"
+    attr_reader :wait_function
+    # @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 [Vapi::LivekitSmartEndpointingPlanProvider] This is the provider for the smart endpointing plan.
+    # @param wait_function [String] This expression describes how long the bot will wait to start speaking based on
+    #  the likelihood that the user has reached an endpoint.
+    #  This is a millisecond valued function. It maps probabilities (real numbers on
+    #  [0,1]) to milliseconds that the bot should wait before speaking ([0, \infty]).
+    #  Any negative values that are returned are set to zero (the bot can't start
+    #  talking in the past).
+    #  A probability of zero represents very high confidence that the caller has
+    #  stopped speaking, and would like the bot to speak to them. A probability of one
+    #  represents very high confidence that the caller is still speaking.
+    #  Under the hood, this is parsed into a mathjs expression. Whatever you use to
+    #  write your expression needs to be valid with respect to mathjs
+    #  @default "20 + 500 * sqrt(x) + 2500 * x^3"
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::LivekitSmartEndpointingPlan]
+    def initialize(provider:, wait_function: OMIT, additional_properties: nil)
+      @provider = provider
+      @wait_function = wait_function if wait_function != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "provider": provider, "waitFunction": wait_function }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of LivekitSmartEndpointingPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::LivekitSmartEndpointingPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      provider = parsed_json["provider"]
+      wait_function = parsed_json["waitFunction"]
+      new(
+        provider: provider,
+        wait_function: wait_function,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of LivekitSmartEndpointingPlan 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?(Vapi::LivekitSmartEndpointingPlanProvider) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
+      obj.wait_function&.is_a?(String) != false || raise("Passed value for field obj.wait_function is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/livekit_smart_endpointing_plan_provider.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the provider for the smart endpointing plan.
+  class LivekitSmartEndpointingPlanProvider
+    VAPI = "vapi"
+    LIVEKIT = "livekit"
+    CUSTOM_ENDPOINTING_MODEL = "custom-endpointing-model"
+  end
+end

data/lib/vapi_server_sdk/types/lmnt_voice.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "lmnt_voice_id"
+require_relative "lmnt_voice_language"
 require_relative "chunk_plan"
 require_relative "fallback_plan"
 require "ostruct"
@@ -8,10 +9,14 @@ require "json"
 
 module Vapi
   class LmntVoice
+    # @return [Boolean] This is the flag to toggle voice caching for the assistant.
+    attr_reader :caching_enabled
     # @return [Vapi::LmntVoiceId] 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.
     attr_reader :speed
+    # @return [Vapi::LmntVoiceLanguage] Two letter ISO 639-1 language code. Use "auto" for auto-detection.
+    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
@@ -26,23 +31,30 @@ module Vapi
 
     OMIT = Object.new
 
+    # @param caching_enabled [Boolean] This is the flag to toggle voice caching for the assistant.
     # @param voice_id [Vapi::LmntVoiceId] This is the provider-specific ID that will be used.
     # @param speed [Float] This is the speed multiplier that will be used.
+    # @param language [Vapi::LmntVoiceLanguage] Two letter ISO 639-1 language code. Use "auto" for auto-detection.
     # @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::LmntVoice]
-    def initialize(voice_id:, speed: OMIT, chunk_plan: OMIT, fallback_plan: OMIT, additional_properties: nil)
+    def initialize(voice_id:, caching_enabled: OMIT, speed: OMIT, language: OMIT, chunk_plan: OMIT,
+                   fallback_plan: OMIT, additional_properties: nil)
+      @caching_enabled = caching_enabled if caching_enabled != OMIT
       @voice_id = voice_id
       @speed = speed if speed != 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 = {
+        "cachingEnabled": caching_enabled,
         "voiceId": voice_id,
         "speed": speed,
+        "language": language,
         "chunkPlan": chunk_plan,
         "fallbackPlan": fallback_plan
       }.reject do |_k, v|
@@ -57,6 +69,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
@@ -64,6 +77,7 @@ module Vapi
         voice_id = Vapi::LmntVoiceId.from_json(json_object: voice_id)
       end
       speed = parsed_json["speed"]
+      language = parsed_json["language"]
       if parsed_json["chunkPlan"].nil?
         chunk_plan = nil
       else
@@ -77,8 +91,10 @@ module Vapi
         fallback_plan = Vapi::FallbackPlan.from_json(json_object: fallback_plan)
       end
       new(
+        caching_enabled: caching_enabled,
         voice_id: voice_id,
         speed: speed,
+        language: language,
         chunk_plan: chunk_plan,
         fallback_plan: fallback_plan,
         additional_properties: struct
@@ -99,8 +115,10 @@ 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::LmntVoiceId.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.language&.is_a?(Vapi::LmntVoiceLanguage) != 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

data/lib/vapi_server_sdk/types/lmnt_voice_id_enum.rb

@@ -2,7 +2,47 @@
 
 module Vapi
   class LmntVoiceIdEnum
-    LILY = "lily"
+    AMY = "amy"
+    ANSEL = "ansel"
+    AUTUMN = "autumn"
+    AVA = "ava"
+    BRANDON = "brandon"
+    CALEB = "caleb"
+    CASSIAN = "cassian"
+    CHLOE = "chloe"
+    DALTON = "dalton"
     DANIEL = "daniel"
+    DUSTIN = "dustin"
+    ELOWEN = "elowen"
+    EVANDER = "evander"
+    HUXLEY = "huxley"
+    JAMES = "james"
+    JUNIPER = "juniper"
+    KENNEDY = "kennedy"
+    LAUREN = "lauren"
+    LEAH = "leah"
+    LILY = "lily"
+    LUCAS = "lucas"
+    MAGNUS = "magnus"
+    MILES = "miles"
+    MORGAN = "morgan"
+    NATALIE = "natalie"
+    NATHAN = "nathan"
+    NOAH = "noah"
+    NYSSA = "nyssa"
+    OLIVER = "oliver"
+    PAIGE = "paige"
+    RYAN = "ryan"
+    SADIE = "sadie"
+    SOPHIE = "sophie"
+    STELLA = "stella"
+    TERRENCE = "terrence"
+    TYLER = "tyler"
+    VESPER = "vesper"
+    VIOLET = "violet"
+    WARRICK = "warrick"
+    ZAIN = "zain"
+    ZEKE = "zeke"
+    ZOE = "zoe"
   end
 end

data/lib/vapi_server_sdk/types/lmnt_voice_language.rb

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

data/lib/vapi_server_sdk/types/logic_edge_condition.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Vapi
+  LOGIC_EDGE_CONDITION = Object
+end

data/lib/vapi_server_sdk/types/make_tool.rb

@@ -3,20 +3,12 @@
 require_relative "make_tool_messages_item"
 require "date"
 require_relative "open_ai_function"
-require_relative "server"
 require_relative "make_tool_metadata"
 require "ostruct"
 require "json"
 
 module Vapi
   class MakeTool
-    # @return [Boolean] This determines if the tool is async.
-    #  If async, the assistant will move forward without waiting for your server to
-    #  respond. This is useful if you just want to trigger something on your server.
-    #  If sync, the assistant will wait for your server to respond. This is useful if
-    #  want assistant to respond with the result from your server.
-    #  Defaults to synchronous (`false`).
-    attr_reader :async
     # @return [Array<Vapi::MakeToolMessagesItem>] These are the messages that will be spoken to the user as the tool is running.
     #  For some tools, this is auto-filled based on special fields like
     #  `tool.destinations`. For others like the function tool, these can be custom
@@ -40,13 +32,6 @@ module Vapi
     #  "request-complete" messages. One of these messages will be triggered if the
     #  `messages[].conditions` matches the "reason" argument.
     attr_reader :function
-    # @return [Vapi::Server] This is the server that will be hit when this tool is requested by the model.
-    #  All requests will be sent with the call object among other things. You can find
-    #  more details in the Server URL documentation.
-    #  This overrides the serverUrl set on the org and the phoneNumber. Order of
-    #  precedence: highest tool.server.url, then assistant.serverUrl, then
-    #  phoneNumber.serverUrl, then org.serverUrl.
-    attr_reader :server
     # @return [Vapi::MakeToolMetadata]
     attr_reader :metadata
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -57,12 +42,6 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param async [Boolean] This determines if the tool is async.
-    #  If async, the assistant will move forward without waiting for your server to
-    #  respond. This is useful if you just want to trigger something on your server.
-    #  If sync, the assistant will wait for your server to respond. This is useful if
-    #  want assistant to respond with the result from your server.
-    #  Defaults to synchronous (`false`).
     # @param messages [Array<Vapi::MakeToolMessagesItem>] These are the messages that will be spoken to the user as the tool is running.
     #  For some tools, this is auto-filled based on special fields like
     #  `tool.destinations`. For others like the function tool, these can be custom
@@ -80,36 +59,26 @@ module Vapi
     #  argument "reason". Then, in `messages` array, you can have many
     #  "request-complete" messages. One of these messages will be triggered if the
     #  `messages[].conditions` matches the "reason" argument.
-    # @param server [Vapi::Server] This is the server that will be hit when this tool is requested by the model.
-    #  All requests will be sent with the call object among other things. You can find
-    #  more details in the Server URL documentation.
-    #  This overrides the serverUrl set on the org and the phoneNumber. Order of
-    #  precedence: highest tool.server.url, then assistant.serverUrl, then
-    #  phoneNumber.serverUrl, then org.serverUrl.
     # @param metadata [Vapi::MakeToolMetadata]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::MakeTool]
-    def initialize(id:, org_id:, created_at:, updated_at:, metadata:, async: OMIT, messages: OMIT, function: OMIT,
-                   server: OMIT, additional_properties: nil)
-      @async = async if async != OMIT
+    def initialize(id:, org_id:, created_at:, updated_at:, metadata:, messages: OMIT, function: OMIT,
+                   additional_properties: nil)
       @messages = messages if messages != OMIT
       @id = id
       @org_id = org_id
       @created_at = created_at
       @updated_at = updated_at
       @function = function if function != OMIT
-      @server = server if server != OMIT
       @metadata = metadata
       @additional_properties = additional_properties
       @_field_set = {
-        "async": async,
         "messages": messages,
         "id": id,
         "orgId": org_id,
         "createdAt": created_at,
         "updatedAt": updated_at,
         "function": function,
-        "server": server,
         "metadata": metadata
       }.reject do |_k, v|
         v == OMIT
@@ -123,7 +92,6 @@ module Vapi
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      async = parsed_json["async"]
       messages = parsed_json["messages"]&.map do |item|
         item = item.to_json
         Vapi::MakeToolMessagesItem.from_json(json_object: item)
@@ -138,12 +106,6 @@ module Vapi
         function = parsed_json["function"].to_json
         function = Vapi::OpenAiFunction.from_json(json_object: function)
       end
-      if parsed_json["server"].nil?
-        server = nil
-      else
-        server = parsed_json["server"].to_json
-        server = Vapi::Server.from_json(json_object: server)
-      end
       if parsed_json["metadata"].nil?
         metadata = nil
       else
@@ -151,14 +113,12 @@ module Vapi
         metadata = Vapi::MakeToolMetadata.from_json(json_object: metadata)
       end
       new(
-        async: async,
         messages: messages,
         id: id,
         org_id: org_id,
         created_at: created_at,
         updated_at: updated_at,
         function: function,
-        server: server,
         metadata: metadata,
         additional_properties: struct
       )
@@ -178,14 +138,12 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.async&.is_a?(Boolean) != false || raise("Passed value for field obj.async is not the expected type, validation failed.")
       obj.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages 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.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)
-      obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
       Vapi::MakeToolMetadata.validate_raw(obj: obj.metadata)
     end
   end