vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/json_schema.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "json_schema_type"
+require_relative "json_schema_format"
 require "ostruct"
 require "json"
 
@@ -28,12 +29,24 @@ module Vapi
     attr_reader :properties
     # @return [String] This is the description to help the model understand what it needs to output.
     attr_reader :description
+    # @return [String] This is the pattern of the string. This is a regex that will be used to validate
+    #  the data in question. To use a common format, use the `format` property instead.
+    #  OpenAI documentation:
+    #  https://platform.openai.com/docs/guides/structured-outputs#supported-properties
+    attr_reader :pattern
+    # @return [Vapi::JsonSchemaFormat] This is the format of the string. To pass a regex, use the `pattern` property
+    #  instead.
+    #  OpenAI documentation:
+    #  cs/guides/structured-outputs?api-mode=chat&type-restrictions=string-restrictions
+    attr_reader :format
     # @return [Array<String>] This is a list of properties that are required.
     #  This only makes sense if the type is "object".
     attr_reader :required
     # @return [Array<String>] This array specifies the allowed values that can be used to restrict the output
     #  of the model.
     attr_reader :enum
+    # @return [String] This is the title of the schema.
+    attr_reader :title
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -60,28 +73,43 @@ module Vapi
     #  This is a map of string to JsonSchema. However, Swagger doesn't support circular
     #  references.
     # @param description [String] This is the description to help the model understand what it needs to output.
+    # @param pattern [String] This is the pattern of the string. This is a regex that will be used to validate
+    #  the data in question. To use a common format, use the `format` property instead.
+    #  OpenAI documentation:
+    #  https://platform.openai.com/docs/guides/structured-outputs#supported-properties
+    # @param format [Vapi::JsonSchemaFormat] This is the format of the string. To pass a regex, use the `pattern` property
+    #  instead.
+    #  OpenAI documentation:
+    #  cs/guides/structured-outputs?api-mode=chat&type-restrictions=string-restrictions
     # @param required [Array<String>] This is a list of properties that are required.
     #  This only makes sense if the type is "object".
     # @param enum [Array<String>] This array specifies the allowed values that can be used to restrict the output
     #  of the model.
+    # @param title [String] This is the title of the schema.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::JsonSchema]
-    def initialize(type:, items: OMIT, properties: OMIT, description: OMIT, required: OMIT, enum: OMIT,
-                   additional_properties: nil)
+    def initialize(type:, items: OMIT, properties: OMIT, description: OMIT, pattern: OMIT, format: OMIT,
+                   required: OMIT, enum: OMIT, title: OMIT, additional_properties: nil)
       @type = type
       @items = items if items != OMIT
       @properties = properties if properties != OMIT
       @description = description if description != OMIT
+      @pattern = pattern if pattern != OMIT
+      @format = format if format != OMIT
       @required = required if required != OMIT
       @enum = enum if enum != OMIT
+      @title = title if title != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "type": type,
         "items": items,
         "properties": properties,
         "description": description,
+        "pattern": pattern,
+        "format": format,
         "required": required,
-        "enum": enum
+        "enum": enum,
+        "title": title
       }.reject do |_k, v|
         v == OMIT
       end
@@ -98,15 +126,21 @@ module Vapi
       items = parsed_json["items"]
       properties = parsed_json["properties"]
       description = parsed_json["description"]
+      pattern = parsed_json["pattern"]
+      format = parsed_json["format"]
       required = parsed_json["required"]
       enum = parsed_json["enum"]
+      title = parsed_json["title"]
       new(
         type: type,
         items: items,
         properties: properties,
         description: description,
+        pattern: pattern,
+        format: format,
         required: required,
         enum: enum,
+        title: title,
         additional_properties: struct
       )
     end
@@ -129,8 +163,11 @@ module Vapi
       obj.items&.is_a?(Hash) != false || raise("Passed value for field obj.items is not the expected type, validation failed.")
       obj.properties&.is_a?(Hash) != false || raise("Passed value for field obj.properties is not the expected type, validation failed.")
       obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+      obj.pattern&.is_a?(String) != false || raise("Passed value for field obj.pattern is not the expected type, validation failed.")
+      obj.format&.is_a?(Vapi::JsonSchemaFormat) != false || raise("Passed value for field obj.format is not the expected type, validation failed.")
       obj.required&.is_a?(Array) != false || raise("Passed value for field obj.required is not the expected type, validation failed.")
       obj.enum&.is_a?(Array) != false || raise("Passed value for field obj.enum is not the expected type, validation failed.")
+      obj.title&.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/json_schema_format.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the format of the string. To pass a regex, use the `pattern` property
+  #  instead.
+  #  OpenAI documentation:
+  #  cs/guides/structured-outputs?api-mode=chat&type-restrictions=string-restrictions
+  class JsonSchemaFormat
+    DATE_TIME = "date-time"
+    TIME = "time"
+    DATE = "date"
+    DURATION = "duration"
+    EMAIL = "email"
+    HOSTNAME = "hostname"
+    IPV_4 = "ipv4"
+    IPV_6 = "ipv6"
+    UUID = "uuid"
+  end
+end

data/lib/vapi_server_sdk/types/jwt_response.rb

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

data/lib/vapi_server_sdk/types/keypad_input_plan.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative "keypad_input_plan_delimiters"
+require "ostruct"
+require "json"
+
+module Vapi
+  class KeypadInputPlan
+    # @return [Boolean] This keeps track of whether the user has enabled keypad input.
+    #  By default, it is off.
+    #  @default false
+    attr_reader :enabled
+    # @return [Float] This is the time in seconds to wait before processing the input.
+    #  If the input is not received within this time, the input will be ignored.
+    #  If set to "off", the input will be processed when the user enters a delimiter or
+    #  immediately if no delimiter is used.
+    #  @default 2
+    attr_reader :timeout_seconds
+    # @return [Vapi::KeypadInputPlanDelimiters] This is the delimiter(s) that will be used to process the input.
+    #  Can be '#', '*', or an empty array.
+    attr_reader :delimiters
+    # @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 enabled [Boolean] This keeps track of whether the user has enabled keypad input.
+    #  By default, it is off.
+    #  @default false
+    # @param timeout_seconds [Float] This is the time in seconds to wait before processing the input.
+    #  If the input is not received within this time, the input will be ignored.
+    #  If set to "off", the input will be processed when the user enters a delimiter or
+    #  immediately if no delimiter is used.
+    #  @default 2
+    # @param delimiters [Vapi::KeypadInputPlanDelimiters] This is the delimiter(s) that will be used to process the input.
+    #  Can be '#', '*', or an empty array.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::KeypadInputPlan]
+    def initialize(enabled: OMIT, timeout_seconds: OMIT, delimiters: OMIT, additional_properties: nil)
+      @enabled = enabled if enabled != OMIT
+      @timeout_seconds = timeout_seconds if timeout_seconds != OMIT
+      @delimiters = delimiters if delimiters != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "enabled": enabled,
+        "timeoutSeconds": timeout_seconds,
+        "delimiters": delimiters
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of KeypadInputPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::KeypadInputPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      enabled = parsed_json["enabled"]
+      timeout_seconds = parsed_json["timeoutSeconds"]
+      delimiters = parsed_json["delimiters"]
+      new(
+        enabled: enabled,
+        timeout_seconds: timeout_seconds,
+        delimiters: delimiters,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of KeypadInputPlan 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.enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.enabled is not the expected type, validation failed.")
+      obj.timeout_seconds&.is_a?(Float) != false || raise("Passed value for field obj.timeout_seconds is not the expected type, validation failed.")
+      obj.delimiters&.is_a?(Vapi::KeypadInputPlanDelimiters) != false || raise("Passed value for field obj.delimiters is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/keypad_input_plan_delimiters.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the delimiter(s) that will be used to process the input.
+  #  Can be '#', '*', or an empty array.
+  class KeypadInputPlanDelimiters
+    HASH = "#"
+    ASTERISK = "*"
+    EMPTY = ""
+  end
+end

data/lib/vapi_server_sdk/types/knowledge_base.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative "knowledge_base_model"
+require "ostruct"
+require "json"
+
+module Vapi
+  class KnowledgeBase
+    # @return [String] The name of the knowledge base
+    attr_reader :name
+    # @return [String] The provider of the knowledge base
+    attr_reader :provider
+    # @return [Vapi::KnowledgeBaseModel] The model to use for the knowledge base
+    attr_reader :model
+    # @return [String] A description of the knowledge base
+    attr_reader :description
+    # @return [Array<String>] The file IDs associated with this knowledge base
+    attr_reader :file_ids
+    # @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 name [String] The name of the knowledge base
+    # @param provider [String] The provider of the knowledge base
+    # @param model [Vapi::KnowledgeBaseModel] The model to use for the knowledge base
+    # @param description [String] A description of the knowledge base
+    # @param file_ids [Array<String>] The file IDs associated with this knowledge base
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::KnowledgeBase]
+    def initialize(name:, provider:, description:, file_ids:, model: OMIT, additional_properties: nil)
+      @name = name
+      @provider = provider
+      @model = model if model != OMIT
+      @description = description
+      @file_ids = file_ids
+      @additional_properties = additional_properties
+      @_field_set = {
+        "name": name,
+        "provider": provider,
+        "model": model,
+        "description": description,
+        "fileIds": file_ids
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of KnowledgeBase
+    #
+    # @param json_object [String]
+    # @return [Vapi::KnowledgeBase]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      provider = parsed_json["provider"]
+      model = parsed_json["model"]
+      description = parsed_json["description"]
+      file_ids = parsed_json["fileIds"]
+      new(
+        name: name,
+        provider: provider,
+        model: model,
+        description: description,
+        file_ids: file_ids,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of KnowledgeBase 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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.provider.is_a?(String) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
+      obj.model&.is_a?(Vapi::KnowledgeBaseModel) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
+      obj.description.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+      obj.file_ids.is_a?(Array) != false || raise("Passed value for field obj.file_ids is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/knowledge_base_cost.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class KnowledgeBaseCost
+    # @return [Hash{String => Object}] This is the model that was used for processing the knowledge base.
+    attr_reader :model
+    # @return [Float] This is the number of prompt tokens used in the knowledge base query.
+    attr_reader :prompt_tokens
+    # @return [Float] This is the number of completion tokens generated in the knowledge base query.
+    attr_reader :completion_tokens
+    # @return [Float] This is the cost of the component in USD.
+    attr_reader :cost
+    # @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 model [Hash{String => Object}] This is the model that was used for processing the knowledge base.
+    # @param prompt_tokens [Float] This is the number of prompt tokens used in the knowledge base query.
+    # @param completion_tokens [Float] This is the number of completion tokens generated in the knowledge base query.
+    # @param cost [Float] This is the cost of the component in USD.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::KnowledgeBaseCost]
+    def initialize(model:, prompt_tokens:, completion_tokens:, cost:, additional_properties: nil)
+      @model = model
+      @prompt_tokens = prompt_tokens
+      @completion_tokens = completion_tokens
+      @cost = cost
+      @additional_properties = additional_properties
+      @_field_set = {
+        "model": model,
+        "promptTokens": prompt_tokens,
+        "completionTokens": completion_tokens,
+        "cost": cost
+      }
+    end
+
+    # Deserialize a JSON object to an instance of KnowledgeBaseCost
+    #
+    # @param json_object [String]
+    # @return [Vapi::KnowledgeBaseCost]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      model = parsed_json["model"]
+      prompt_tokens = parsed_json["promptTokens"]
+      completion_tokens = parsed_json["completionTokens"]
+      cost = parsed_json["cost"]
+      new(
+        model: model,
+        prompt_tokens: prompt_tokens,
+        completion_tokens: completion_tokens,
+        cost: cost,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of KnowledgeBaseCost 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.model.is_a?(Hash) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
+      obj.prompt_tokens.is_a?(Float) != false || raise("Passed value for field obj.prompt_tokens is not the expected type, validation failed.")
+      obj.completion_tokens.is_a?(Float) != false || raise("Passed value for field obj.completion_tokens is not the expected type, validation failed.")
+      obj.cost.is_a?(Float) != false || raise("Passed value for field obj.cost is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/knowledge_base_model.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Vapi
+  # The model to use for the knowledge base
+  class KnowledgeBaseModel
+    GEMINI_25_PRO = "gemini-2.5-pro"
+    GEMINI_25_FLASH = "gemini-2.5-flash"
+    GEMINI_25_FLASH_LITE = "gemini-2.5-flash-lite"
+    GEMINI_25_PRO_PREVIEW_0506 = "gemini-2.5-pro-preview-05-06"
+    GEMINI_25_FLASH_PREVIEW_0520 = "gemini-2.5-flash-preview-05-20"
+    GEMINI_25_FLASH_PREVIEW_0417 = "gemini-2.5-flash-preview-04-17"
+    GEMINI_20_FLASH_THINKING_EXP = "gemini-2.0-flash-thinking-exp"
+    GEMINI_20_PRO_EXP_0205 = "gemini-2.0-pro-exp-02-05"
+    GEMINI_20_FLASH = "gemini-2.0-flash"
+    GEMINI_20_FLASH_LITE = "gemini-2.0-flash-lite"
+    GEMINI_20_FLASH_LITE_PREVIEW_0205 = "gemini-2.0-flash-lite-preview-02-05"
+    GEMINI_20_FLASH_EXP = "gemini-2.0-flash-exp"
+    GEMINI_20_FLASH_REALTIME_EXP = "gemini-2.0-flash-realtime-exp"
+    GEMINI_15_FLASH = "gemini-1.5-flash"
+    GEMINI_15_FLASH_002 = "gemini-1.5-flash-002"
+    GEMINI_15_PRO = "gemini-1.5-pro"
+    GEMINI_15_PRO_002 = "gemini-1.5-pro-002"
+    GEMINI_10_PRO = "gemini-1.0-pro"
+  end
+end

data/lib/vapi_server_sdk/types/langfuse_observability_plan.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class LangfuseObservabilityPlan
+    # @return [String]
+    attr_reader :provider
+    # @return [Array<String>] This is an array of tags to be added to the Langfuse trace. Tags allow you to
+    #  categorize and filter traces. https://langfuse.com/docs/tracing-features/tags
+    attr_reader :tags
+    # @return [Hash{String => Object}] This is a JSON object that will be added to the Langfuse trace. Traces can be
+    #  enriched with metadata to better understand your users, application, and
+    #  experiments. https://langfuse.com/docs/tracing-features/metadata
+    #  By default it includes the call metadata, assistant metadata, and assistant
+    #  overrides.
+    attr_reader :metadata
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param provider [String]
+    # @param tags [Array<String>] This is an array of tags to be added to the Langfuse trace. Tags allow you to
+    #  categorize and filter traces. https://langfuse.com/docs/tracing-features/tags
+    # @param metadata [Hash{String => Object}] This is a JSON object that will be added to the Langfuse trace. Traces can be
+    #  enriched with metadata to better understand your users, application, and
+    #  experiments. https://langfuse.com/docs/tracing-features/metadata
+    #  By default it includes the call metadata, assistant metadata, and assistant
+    #  overrides.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::LangfuseObservabilityPlan]
+    def initialize(provider:, tags:, metadata: OMIT, additional_properties: nil)
+      @provider = provider
+      @tags = tags
+      @metadata = metadata if metadata != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "provider": provider, "tags": tags, "metadata": metadata }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of LangfuseObservabilityPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::LangfuseObservabilityPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      provider = parsed_json["provider"]
+      tags = parsed_json["tags"]
+      metadata = parsed_json["metadata"]
+      new(
+        provider: provider,
+        tags: tags,
+        metadata: metadata,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of LangfuseObservabilityPlan 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.tags.is_a?(Array) != false || raise("Passed value for field obj.tags is not the expected type, validation failed.")
+      obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
+    end
+  end
+end