vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/variable_extraction_plan.rb

@@ -0,0 +1,297 @@
+# frozen_string_literal: true
+
+require_relative "json_schema"
+require_relative "variable_extraction_alias"
+require "ostruct"
+require "json"
+
+module Vapi
+  class VariableExtractionPlan
+    # @return [Vapi::JsonSchema] This is the schema to extract.
+    #  Examples:
+    #  1. To extract object properties, you can use the following schema:
+    #  ```json
+    #  {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "string"
+    #  },
+    #  "age": {
+    #  "type": "number"
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  These will be extracted as `{{ name }}` and `{{ age }}` respectively. To
+    #  emphasize, object properties are extracted as direct global variables.
+    #  2. To extract nested properties, you can use the following schema:
+    #  ```json
+    #  {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "object",
+    #  "properties": {
+    #  "first": {
+    #  "type": "string"
+    #  },
+    #  "last": {
+    #  "type": "string"
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  These will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{
+    #  name.last }}` will be accessible.
+    #  3. To extract array items, you can use the following schema:
+    #  ```json
+    #  {
+    #  "type": "array",
+    #  "title": "zipCodes",
+    #  "items": {
+    #  "type": "string"
+    #  }
+    #  }
+    #  ```
+    #  This will be extracted as `{{ zipCodes }}`. To access the array items, you can
+    #  use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.
+    #  4. To extract array of objects, you can use the following schema:
+    #  ```json
+    #  {
+    #  "type": "array",
+    #  "name": "people",
+    #  "items": {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "string"
+    #  },
+    #  "age": {
+    #  "type": "number"
+    #  },
+    #  "zipCodes": {
+    #  "type": "array",
+    #  "items": {
+    #  "type": "string"
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  This will be extracted as `{{ people }}`. To access the array items, you can use
+    #  `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{
+    #  people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.
+    attr_reader :schema
+    # @return [Array<Vapi::VariableExtractionAlias>] These are additional variables to create.
+    #  These will be accessible during the call as `{{key}}` and stored in
+    #  `call.artifact.variableValues` after the call.
+    #  Example:
+    #  ```json
+    #  {
+    #  "aliases": [
+    #  {
+    #  "key": "customerName",
+    #  "value": "{{name}}"
+    #  },
+    #  {
+    #  "key": "fullName",
+    #  "value": "{{firstName}} {{lastName}}"
+    #  },
+    #  {
+    #  "key": "greeting",
+    #  "value": "Hello {{name}}, welcome to {{company}}!"
+    #  },
+    #  {
+    #  "key": "customerEmail",
+    #  "value": "{{addresses[0].city}}"
+    #  },
+    #  {
+    #  "key": "something",
+    #  "value": "{{any liquid}}"
+    #  }
+    #  ]
+    #  }
+    #  ```
+    #  This will create variables `customerName`, `fullName`, `customerEmail`,
+    #  `greeting`, and `something`. To access these variables, you can reference them
+    #  as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and
+    #  `{{something}}`.
+    attr_reader :aliases
+    # @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 schema [Vapi::JsonSchema] This is the schema to extract.
+    #  Examples:
+    #  1. To extract object properties, you can use the following schema:
+    #  ```json
+    #  {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "string"
+    #  },
+    #  "age": {
+    #  "type": "number"
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  These will be extracted as `{{ name }}` and `{{ age }}` respectively. To
+    #  emphasize, object properties are extracted as direct global variables.
+    #  2. To extract nested properties, you can use the following schema:
+    #  ```json
+    #  {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "object",
+    #  "properties": {
+    #  "first": {
+    #  "type": "string"
+    #  },
+    #  "last": {
+    #  "type": "string"
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  These will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{
+    #  name.last }}` will be accessible.
+    #  3. To extract array items, you can use the following schema:
+    #  ```json
+    #  {
+    #  "type": "array",
+    #  "title": "zipCodes",
+    #  "items": {
+    #  "type": "string"
+    #  }
+    #  }
+    #  ```
+    #  This will be extracted as `{{ zipCodes }}`. To access the array items, you can
+    #  use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.
+    #  4. To extract array of objects, you can use the following schema:
+    #  ```json
+    #  {
+    #  "type": "array",
+    #  "name": "people",
+    #  "items": {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "string"
+    #  },
+    #  "age": {
+    #  "type": "number"
+    #  },
+    #  "zipCodes": {
+    #  "type": "array",
+    #  "items": {
+    #  "type": "string"
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  This will be extracted as `{{ people }}`. To access the array items, you can use
+    #  `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{
+    #  people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.
+    # @param aliases [Array<Vapi::VariableExtractionAlias>] These are additional variables to create.
+    #  These will be accessible during the call as `{{key}}` and stored in
+    #  `call.artifact.variableValues` after the call.
+    #  Example:
+    #  ```json
+    #  {
+    #  "aliases": [
+    #  {
+    #  "key": "customerName",
+    #  "value": "{{name}}"
+    #  },
+    #  {
+    #  "key": "fullName",
+    #  "value": "{{firstName}} {{lastName}}"
+    #  },
+    #  {
+    #  "key": "greeting",
+    #  "value": "Hello {{name}}, welcome to {{company}}!"
+    #  },
+    #  {
+    #  "key": "customerEmail",
+    #  "value": "{{addresses[0].city}}"
+    #  },
+    #  {
+    #  "key": "something",
+    #  "value": "{{any liquid}}"
+    #  }
+    #  ]
+    #  }
+    #  ```
+    #  This will create variables `customerName`, `fullName`, `customerEmail`,
+    #  `greeting`, and `something`. To access these variables, you can reference them
+    #  as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and
+    #  `{{something}}`.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::VariableExtractionPlan]
+    def initialize(schema: OMIT, aliases: OMIT, additional_properties: nil)
+      @schema = schema if schema != OMIT
+      @aliases = aliases if aliases != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "schema": schema, "aliases": aliases }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of VariableExtractionPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::VariableExtractionPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["schema"].nil?
+        schema = nil
+      else
+        schema = parsed_json["schema"].to_json
+        schema = Vapi::JsonSchema.from_json(json_object: schema)
+      end
+      aliases = parsed_json["aliases"]&.map do |item|
+        item = item.to_json
+        Vapi::VariableExtractionAlias.from_json(json_object: item)
+      end
+      new(
+        schema: schema,
+        aliases: aliases,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of VariableExtractionPlan 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.schema.nil? || Vapi::JsonSchema.validate_raw(obj: obj.schema)
+      obj.aliases&.is_a?(Array) != false || raise("Passed value for field obj.aliases is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/voicemail_detection_backoff_plan.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class VoicemailDetectionBackoffPlan
+    # @return [Float] This is the number of seconds to wait before starting the first retry attempt.
+    attr_reader :start_at_seconds
+    # @return [Float] This is the interval in seconds between retry attempts.
+    attr_reader :frequency_seconds
+    # @return [Float] This is the maximum number of retry attempts before giving up.
+    attr_reader :max_retries
+    # @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 start_at_seconds [Float] This is the number of seconds to wait before starting the first retry attempt.
+    # @param frequency_seconds [Float] This is the interval in seconds between retry attempts.
+    # @param max_retries [Float] This is the maximum number of retry attempts before giving up.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::VoicemailDetectionBackoffPlan]
+    def initialize(start_at_seconds: OMIT, frequency_seconds: OMIT, max_retries: OMIT, additional_properties: nil)
+      @start_at_seconds = start_at_seconds if start_at_seconds != OMIT
+      @frequency_seconds = frequency_seconds if frequency_seconds != OMIT
+      @max_retries = max_retries if max_retries != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "startAtSeconds": start_at_seconds,
+        "frequencySeconds": frequency_seconds,
+        "maxRetries": max_retries
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of VoicemailDetectionBackoffPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::VoicemailDetectionBackoffPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      start_at_seconds = parsed_json["startAtSeconds"]
+      frequency_seconds = parsed_json["frequencySeconds"]
+      max_retries = parsed_json["maxRetries"]
+      new(
+        start_at_seconds: start_at_seconds,
+        frequency_seconds: frequency_seconds,
+        max_retries: max_retries,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of VoicemailDetectionBackoffPlan 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.start_at_seconds&.is_a?(Float) != false || raise("Passed value for field obj.start_at_seconds is not the expected type, validation failed.")
+      obj.frequency_seconds&.is_a?(Float) != false || raise("Passed value for field obj.frequency_seconds is not the expected type, validation failed.")
+      obj.max_retries&.is_a?(Float) != false || raise("Passed value for field obj.max_retries is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/voicemail_detection_cost.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require_relative "voicemail_detection_cost_provider"
+require "ostruct"
+require "json"
+
+module Vapi
+  class VoicemailDetectionCost
+    # @return [Hash{String => Object}] This is the model that was used to perform the analysis.
+    attr_reader :model
+    # @return [Vapi::VoicemailDetectionCostProvider] This is the provider that was used to detect the voicemail.
+    attr_reader :provider
+    # @return [Float] This is the number of prompt text tokens used in the voicemail detection.
+    attr_reader :prompt_text_tokens
+    # @return [Float] This is the number of prompt audio tokens used in the voicemail detection.
+    attr_reader :prompt_audio_tokens
+    # @return [Float] This is the number of completion text tokens used in the voicemail detection.
+    attr_reader :completion_text_tokens
+    # @return [Float] This is the number of completion audio tokens used in the voicemail detection.
+    attr_reader :completion_audio_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 to perform the analysis.
+    # @param provider [Vapi::VoicemailDetectionCostProvider] This is the provider that was used to detect the voicemail.
+    # @param prompt_text_tokens [Float] This is the number of prompt text tokens used in the voicemail detection.
+    # @param prompt_audio_tokens [Float] This is the number of prompt audio tokens used in the voicemail detection.
+    # @param completion_text_tokens [Float] This is the number of completion text tokens used in the voicemail detection.
+    # @param completion_audio_tokens [Float] This is the number of completion audio tokens used in the voicemail detection.
+    # @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::VoicemailDetectionCost]
+    def initialize(model:, provider:, prompt_text_tokens:, prompt_audio_tokens:, completion_text_tokens:,
+                   completion_audio_tokens:, cost:, additional_properties: nil)
+      @model = model
+      @provider = provider
+      @prompt_text_tokens = prompt_text_tokens
+      @prompt_audio_tokens = prompt_audio_tokens
+      @completion_text_tokens = completion_text_tokens
+      @completion_audio_tokens = completion_audio_tokens
+      @cost = cost
+      @additional_properties = additional_properties
+      @_field_set = {
+        "model": model,
+        "provider": provider,
+        "promptTextTokens": prompt_text_tokens,
+        "promptAudioTokens": prompt_audio_tokens,
+        "completionTextTokens": completion_text_tokens,
+        "completionAudioTokens": completion_audio_tokens,
+        "cost": cost
+      }
+    end
+
+    # Deserialize a JSON object to an instance of VoicemailDetectionCost
+    #
+    # @param json_object [String]
+    # @return [Vapi::VoicemailDetectionCost]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      model = parsed_json["model"]
+      provider = parsed_json["provider"]
+      prompt_text_tokens = parsed_json["promptTextTokens"]
+      prompt_audio_tokens = parsed_json["promptAudioTokens"]
+      completion_text_tokens = parsed_json["completionTextTokens"]
+      completion_audio_tokens = parsed_json["completionAudioTokens"]
+      cost = parsed_json["cost"]
+      new(
+        model: model,
+        provider: provider,
+        prompt_text_tokens: prompt_text_tokens,
+        prompt_audio_tokens: prompt_audio_tokens,
+        completion_text_tokens: completion_text_tokens,
+        completion_audio_tokens: completion_audio_tokens,
+        cost: cost,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of VoicemailDetectionCost 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.provider.is_a?(Vapi::VoicemailDetectionCostProvider) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
+      obj.prompt_text_tokens.is_a?(Float) != false || raise("Passed value for field obj.prompt_text_tokens is not the expected type, validation failed.")
+      obj.prompt_audio_tokens.is_a?(Float) != false || raise("Passed value for field obj.prompt_audio_tokens is not the expected type, validation failed.")
+      obj.completion_text_tokens.is_a?(Float) != false || raise("Passed value for field obj.completion_text_tokens is not the expected type, validation failed.")
+      obj.completion_audio_tokens.is_a?(Float) != false || raise("Passed value for field obj.completion_audio_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/voicemail_detection_cost_provider.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the provider that was used to detect the voicemail.
+  class VoicemailDetectionCostProvider
+    TWILIO = "twilio"
+    GOOGLE = "google"
+    OPENAI = "openai"
+    VAPI = "vapi"
+  end
+end