vapi_server_sdk 0.1.0 → 0.2.0

data/lib/vapi_server_sdk/types/text_content.rb

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

data/lib/vapi_server_sdk/types/text_content_language.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+module Vapi
+  class TextContentLanguage
+    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"
+  end
+end

data/lib/vapi_server_sdk/types/text_editor_tool.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+require_relative "text_editor_tool_messages_item"
+require "date"
+require_relative "open_ai_function"
+require_relative "server"
+require "ostruct"
+require "json"
+
+module Vapi
+  class TextEditorTool
+    # @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::TextEditorToolMessagesItem>] 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
+    #  configured.
+    attr_reader :messages
+    # @return [String] The sub type of tool.
+    attr_reader :sub_type
+    # @return [String] This is the unique identifier for the tool.
+    attr_reader :id
+    # @return [String] This is the unique identifier for the organization that this tool belongs to.
+    attr_reader :org_id
+    # @return [DateTime] This is the ISO 8601 date-time string of when the tool was created.
+    attr_reader :created_at
+    # @return [DateTime] This is the ISO 8601 date-time string of when the tool was last updated.
+    attr_reader :updated_at
+    # @return [Vapi::OpenAiFunction] This is the function definition of the tool.
+    #  For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on
+    #  tool-specific fields like `tool.destinations`. But, even in those cases, you can
+    #  provide a custom function definition for advanced use cases.
+    #  An example of an advanced use case is if you want to customize the message
+    #  that's spoken for `endCall` tool. You can specify a function where it returns an
+    #  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.
+    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 [String] The name of the tool, fixed to 'str_replace_editor'
+    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 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::TextEditorToolMessagesItem>] 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
+    #  configured.
+    # @param sub_type [String] The sub type of tool.
+    # @param id [String] This is the unique identifier for the tool.
+    # @param org_id [String] This is the unique identifier for the organization that this tool belongs to.
+    # @param created_at [DateTime] This is the ISO 8601 date-time string of when the tool was created.
+    # @param updated_at [DateTime] This is the ISO 8601 date-time string of when the tool was last updated.
+    # @param function [Vapi::OpenAiFunction] This is the function definition of the tool.
+    #  For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on
+    #  tool-specific fields like `tool.destinations`. But, even in those cases, you can
+    #  provide a custom function definition for advanced use cases.
+    #  An example of an advanced use case is if you want to customize the message
+    #  that's spoken for `endCall` tool. You can specify a function where it returns an
+    #  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 name [String] The name of the tool, fixed to 'str_replace_editor'
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::TextEditorTool]
+    def initialize(sub_type:, id:, org_id:, created_at:, updated_at:, name:, async: OMIT, messages: OMIT, function: OMIT,
+                   server: OMIT, additional_properties: nil)
+      @async = async if async != OMIT
+      @messages = messages if messages != OMIT
+      @sub_type = sub_type
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @function = function if function != OMIT
+      @server = server if server != OMIT
+      @name = name
+      @additional_properties = additional_properties
+      @_field_set = {
+        "async": async,
+        "messages": messages,
+        "subType": sub_type,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at,
+        "function": function,
+        "server": server,
+        "name": name
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of TextEditorTool
+    #
+    # @param json_object [String]
+    # @return [Vapi::TextEditorTool]
+    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::TextEditorToolMessagesItem.from_json(json_object: item)
+      end
+      sub_type = parsed_json["subType"]
+      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?)
+      if parsed_json["function"].nil?
+        function = nil
+      else
+        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
+      name = parsed_json["name"]
+      new(
+        async: async,
+        messages: messages,
+        sub_type: sub_type,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        function: function,
+        server: server,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of TextEditorTool 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.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.sub_type.is_a?(String) != false || raise("Passed value for field obj.sub_type 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)
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/text_editor_tool_messages_item.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "tool_message_start"
+require_relative "tool_message_complete"
+require_relative "tool_message_failed"
+require_relative "tool_message_delayed"
+
+module Vapi
+  class TextEditorToolMessagesItem
+    # @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::TextEditorToolMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of TextEditorToolMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::TextEditorToolMessagesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "request-start"
+                 Vapi::ToolMessageStart.from_json(json_object: json_object)
+               when "request-complete"
+                 Vapi::ToolMessageComplete.from_json(json_object: json_object)
+               when "request-failed"
+                 Vapi::ToolMessageFailed.from_json(json_object: json_object)
+               when "request-response-delayed"
+                 Vapi::ToolMessageDelayed.from_json(json_object: json_object)
+               else
+                 Vapi::ToolMessageStart.from_json(json_object: json_object)
+               end
+      new(member: member, discriminant: struct.type)
+    end
+
+    # For Union Types, to_json functionality is delegated to the wrapped member.
+    #
+    # @return [String]
+    def to_json(*_args)
+      case @discriminant
+      when "request-start"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-complete"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-failed"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-response-delayed"
+        { **@member.to_json, type: @discriminant }.to_json
+      else
+        { "type": @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.type
+      when "request-start"
+        Vapi::ToolMessageStart.validate_raw(obj: obj)
+      when "request-complete"
+        Vapi::ToolMessageComplete.validate_raw(obj: obj)
+      when "request-failed"
+        Vapi::ToolMessageFailed.validate_raw(obj: obj)
+      when "request-response-delayed"
+        Vapi::ToolMessageDelayed.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::ToolMessageStart]
+    # @return [Vapi::TextEditorToolMessagesItem]
+    def self.request_start(member:)
+      new(member: member, discriminant: "request-start")
+    end
+
+    # @param member [Vapi::ToolMessageComplete]
+    # @return [Vapi::TextEditorToolMessagesItem]
+    def self.request_complete(member:)
+      new(member: member, discriminant: "request-complete")
+    end
+
+    # @param member [Vapi::ToolMessageFailed]
+    # @return [Vapi::TextEditorToolMessagesItem]
+    def self.request_failed(member:)
+      new(member: member, discriminant: "request-failed")
+    end
+
+    # @param member [Vapi::ToolMessageDelayed]
+    # @return [Vapi::TextEditorToolMessagesItem]
+    def self.request_response_delayed(member:)
+      new(member: member, discriminant: "request-response-delayed")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/together_ai_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 [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -32,15 +34,17 @@ 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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::TogetherAiCredential]
-    def initialize(provider:, api_key:, id:, org_id:, created_at:, updated_at:, additional_properties: nil)
+    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,
@@ -48,8 +52,11 @@ module Vapi
         "id": id,
         "orgId": org_id,
         "createdAt": created_at,
-        "updatedAt": updated_at
-      }
+        "updatedAt": updated_at,
+        "name": name
+      }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of TogetherAiCredential
@@ -65,6 +72,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"]
       new(
         provider: provider,
         api_key: api_key,
@@ -72,6 +80,7 @@ module Vapi
         org_id: org_id,
         created_at: created_at,
         updated_at: updated_at,
+        name: name,
         additional_properties: struct
       )
     end
@@ -96,6 +105,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.")
     end
   end
 end