vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/step_destination.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative "step_destination_conditions_item"
+require "ostruct"
+require "json"
+
+module Vapi
+  class StepDestination
+    # @return [String]
+    attr_reader :type
+    # @return [Array<Vapi::StepDestinationConditionsItem>] This is an optional array of conditions that must be met for this destination to
+    #  be triggered. If empty, this is the default destination that the step transfers
+    #  to.
+    attr_reader :conditions
+    # @return [String]
+    attr_reader :step_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 type [String]
+    # @param conditions [Array<Vapi::StepDestinationConditionsItem>] This is an optional array of conditions that must be met for this destination to
+    #  be triggered. If empty, this is the default destination that the step transfers
+    #  to.
+    # @param step_name [String]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::StepDestination]
+    def initialize(type:, step_name:, conditions: OMIT, additional_properties: nil)
+      @type = type
+      @conditions = conditions if conditions != OMIT
+      @step_name = step_name
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "conditions": conditions, "stepName": step_name }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of StepDestination
+    #
+    # @param json_object [String]
+    # @return [Vapi::StepDestination]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      conditions = parsed_json["conditions"]&.map do |item|
+        item = item.to_json
+        Vapi::StepDestinationConditionsItem.from_json(json_object: item)
+      end
+      step_name = parsed_json["stepName"]
+      new(
+        type: type,
+        conditions: conditions,
+        step_name: step_name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of StepDestination 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.conditions&.is_a?(Array) != false || raise("Passed value for field obj.conditions is not the expected type, validation failed.")
+      obj.step_name.is_a?(String) != false || raise("Passed value for field obj.step_name is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/step_destination_conditions_item.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "model_based_condition"
+require_relative "rule_based_condition"
+
+module Vapi
+  class StepDestinationConditionsItem
+    # @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::StepDestinationConditionsItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of StepDestinationConditionsItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::StepDestinationConditionsItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "model-based"
+                 Vapi::ModelBasedCondition.from_json(json_object: json_object)
+               when "rule-based"
+                 Vapi::RuleBasedCondition.from_json(json_object: json_object)
+               else
+                 Vapi::ModelBasedCondition.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 "model-based"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "rule-based"
+        { **@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 "model-based"
+        Vapi::ModelBasedCondition.validate_raw(obj: obj)
+      when "rule-based"
+        Vapi::RuleBasedCondition.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::ModelBasedCondition]
+    # @return [Vapi::StepDestinationConditionsItem]
+    def self.model_based(member:)
+      new(member: member, discriminant: "model-based")
+    end
+
+    # @param member [Vapi::RuleBasedCondition]
+    # @return [Vapi::StepDestinationConditionsItem]
+    def self.rule_based(member:)
+      new(member: member, discriminant: "rule-based")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/stop_speaking_plan.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class StopSpeakingPlan
+    # @return [Float] This is the number of words that the customer has to say before the assistant
+    #  will stop talking.
+    #  Words like "stop", "actually", "no", etc. will always interrupt immediately
+    #  regardless of this value.
+    #  Words like "okay", "yeah", "right" will never interrupt.
+    #  When set to 0, `voiceSeconds` is used in addition to the transcriptions to
+    #  determine the customer has started speaking.
+    #  Defaults to 0.
+    #  @default 0
+    attr_reader :num_words
+    # @return [Float] This is the seconds customer has to speak before the assistant stops talking.
+    #  This uses the VAD (Voice Activity Detection) spike to determine if the customer
+    #  has started speaking.
+    #  Considerations:
+    #  - A lower value might be more responsive but could potentially pick up
+    #  non-speech sounds.
+    #  - A higher value reduces false positives but might slightly delay the detection
+    #  of speech onset.
+    #  This is only used if `numWords` is set to 0.
+    #  Defaults to 0.2
+    #  @default 0.2
+    attr_reader :voice_seconds
+    # @return [Float] This is the seconds to wait before the assistant will start talking again after
+    #  being interrupted.
+    #  Defaults to 1.
+    #  @default 1
+    attr_reader :backoff_seconds
+    # @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 num_words [Float] This is the number of words that the customer has to say before the assistant
+    #  will stop talking.
+    #  Words like "stop", "actually", "no", etc. will always interrupt immediately
+    #  regardless of this value.
+    #  Words like "okay", "yeah", "right" will never interrupt.
+    #  When set to 0, `voiceSeconds` is used in addition to the transcriptions to
+    #  determine the customer has started speaking.
+    #  Defaults to 0.
+    #  @default 0
+    # @param voice_seconds [Float] This is the seconds customer has to speak before the assistant stops talking.
+    #  This uses the VAD (Voice Activity Detection) spike to determine if the customer
+    #  has started speaking.
+    #  Considerations:
+    #  - A lower value might be more responsive but could potentially pick up
+    #  non-speech sounds.
+    #  - A higher value reduces false positives but might slightly delay the detection
+    #  of speech onset.
+    #  This is only used if `numWords` is set to 0.
+    #  Defaults to 0.2
+    #  @default 0.2
+    # @param backoff_seconds [Float] This is the seconds to wait before the assistant will start talking again after
+    #  being interrupted.
+    #  Defaults to 1.
+    #  @default 1
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::StopSpeakingPlan]
+    def initialize(num_words: OMIT, voice_seconds: OMIT, backoff_seconds: OMIT, additional_properties: nil)
+      @num_words = num_words if num_words != OMIT
+      @voice_seconds = voice_seconds if voice_seconds != OMIT
+      @backoff_seconds = backoff_seconds if backoff_seconds != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "numWords": num_words,
+        "voiceSeconds": voice_seconds,
+        "backoffSeconds": backoff_seconds
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of StopSpeakingPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::StopSpeakingPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      num_words = parsed_json["numWords"]
+      voice_seconds = parsed_json["voiceSeconds"]
+      backoff_seconds = parsed_json["backoffSeconds"]
+      new(
+        num_words: num_words,
+        voice_seconds: voice_seconds,
+        backoff_seconds: backoff_seconds,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of StopSpeakingPlan 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.num_words&.is_a?(Float) != false || raise("Passed value for field obj.num_words is not the expected type, validation failed.")
+      obj.voice_seconds&.is_a?(Float) != false || raise("Passed value for field obj.voice_seconds is not the expected type, validation failed.")
+      obj.backoff_seconds&.is_a?(Float) != false || raise("Passed value for field obj.backoff_seconds is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/structured_data_plan.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require_relative "json_schema"
+require "ostruct"
+require "json"
+
+module Vapi
+  class StructuredDataPlan
+    # @return [Array<Hash{String => Object}>] These are the messages used to generate the structured data.
+    #  @default: ` [ { "role": "system", "content": "You are an expert data extractor.
+    #  You will be given a transcript of a call. Extract structured data per the JSON
+    #  Schema. DO NOT return anything except the structured data.\n\nJson
+    #  Schema:\\n{{schema}}\n\nOnly respond with the JSON." }, { "role": "user",
+    #  "content": "Here is the transcript:\n\n{{transcript}}\n\n" } ]`
+    #  You can customize by providing any messages you want.
+    #  Here are the template variables available:
+    #  - {{transcript}}: the transcript of the call from `call.artifact.transcript`-
+    #  {{systemPrompt}}: the system prompt of the call from
+    #  `assistant.model.messages[type=system].content`- {{schema}}: the schema of the
+    #  structured data from `structuredDataPlan.schema`
+    attr_reader :messages
+    # @return [Boolean] This determines whether structured data is generated and stored in
+    #  `call.analysis.structuredData`. Defaults to false.
+    #  Usage:
+    #  - If you want to extract structured data, set this to true and provide a
+    #  `schema`.
+    #  @default false
+    attr_reader :enabled
+    # @return [Vapi::JsonSchema] This is the schema of the structured data. The output is stored in
+    #  `call.analysis.structuredData`.
+    #  Complete guide on JSON Schema can be found
+    #  [here](https://ajv.js.org/json-schema.html#json-data-type).
+    attr_reader :schema
+    # @return [Float] This is how long the request is tried before giving up. When request times out,
+    #  `call.analysis.structuredData` will be empty.
+    #  Usage:
+    #  - To guarantee the structured data is generated, set this value high. Note, this
+    #  will delay the end of call report in cases where model is slow to respond.
+    #  @default 5 seconds
+    attr_reader :timeout_seconds
+    # @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 messages [Array<Hash{String => Object}>] These are the messages used to generate the structured data.
+    #  @default: ` [ { "role": "system", "content": "You are an expert data extractor.
+    #  You will be given a transcript of a call. Extract structured data per the JSON
+    #  Schema. DO NOT return anything except the structured data.\n\nJson
+    #  Schema:\\n{{schema}}\n\nOnly respond with the JSON." }, { "role": "user",
+    #  "content": "Here is the transcript:\n\n{{transcript}}\n\n" } ]`
+    #  You can customize by providing any messages you want.
+    #  Here are the template variables available:
+    #  - {{transcript}}: the transcript of the call from `call.artifact.transcript`-
+    #  {{systemPrompt}}: the system prompt of the call from
+    #  `assistant.model.messages[type=system].content`- {{schema}}: the schema of the
+    #  structured data from `structuredDataPlan.schema`
+    # @param enabled [Boolean] This determines whether structured data is generated and stored in
+    #  `call.analysis.structuredData`. Defaults to false.
+    #  Usage:
+    #  - If you want to extract structured data, set this to true and provide a
+    #  `schema`.
+    #  @default false
+    # @param schema [Vapi::JsonSchema] This is the schema of the structured data. The output is stored in
+    #  `call.analysis.structuredData`.
+    #  Complete guide on JSON Schema can be found
+    #  [here](https://ajv.js.org/json-schema.html#json-data-type).
+    # @param timeout_seconds [Float] This is how long the request is tried before giving up. When request times out,
+    #  `call.analysis.structuredData` will be empty.
+    #  Usage:
+    #  - To guarantee the structured data is generated, set this value high. Note, this
+    #  will delay the end of call report in cases where model is slow to respond.
+    #  @default 5 seconds
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::StructuredDataPlan]
+    def initialize(messages: OMIT, enabled: OMIT, schema: OMIT, timeout_seconds: OMIT, additional_properties: nil)
+      @messages = messages if messages != OMIT
+      @enabled = enabled if enabled != OMIT
+      @schema = schema if schema != OMIT
+      @timeout_seconds = timeout_seconds if timeout_seconds != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "messages": messages,
+        "enabled": enabled,
+        "schema": schema,
+        "timeoutSeconds": timeout_seconds
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of StructuredDataPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::StructuredDataPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      messages = parsed_json["messages"]
+      enabled = parsed_json["enabled"]
+      if parsed_json["schema"].nil?
+        schema = nil
+      else
+        schema = parsed_json["schema"].to_json
+        schema = Vapi::JsonSchema.from_json(json_object: schema)
+      end
+      timeout_seconds = parsed_json["timeoutSeconds"]
+      new(
+        messages: messages,
+        enabled: enabled,
+        schema: schema,
+        timeout_seconds: timeout_seconds,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of StructuredDataPlan 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.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
+      obj.enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.enabled is not the expected type, validation failed.")
+      obj.schema.nil? || Vapi::JsonSchema.validate_raw(obj: obj.schema)
+      obj.timeout_seconds&.is_a?(Float) != false || raise("Passed value for field obj.timeout_seconds is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/success_evaluation_plan.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require_relative "success_evaluation_plan_rubric"
+require "ostruct"
+require "json"
+
+module Vapi
+  class SuccessEvaluationPlan
+    # @return [Vapi::SuccessEvaluationPlanRubric] This enforces the rubric of the evaluation. The output is stored in
+    #  `call.analysis.successEvaluation`.
+    #  Options include:
+    #  - 'NumericScale': A scale of 1 to 10.
+    #  - 'DescriptiveScale': A scale of Excellent, Good, Fair, Poor.
+    #  - 'Checklist': A checklist of criteria and their status.
+    #  - 'Matrix': A grid that evaluates multiple criteria across different performance
+    #  levels.
+    #  - 'PercentageScale': A scale of 0% to 100%.
+    #  - 'LikertScale': A scale of Strongly Agree, Agree, Neutral, Disagree, Strongly
+    #  Disagree.
+    #  - 'AutomaticRubric': Automatically break down evaluation into several criteria,
+    #  each with its own score.
+    #  - 'PassFail': A simple 'true' if call passed, 'false' if not.
+    #  Default is 'PassFail'.
+    attr_reader :rubric
+    # @return [Array<Hash{String => Object}>] These are the messages used to generate the success evaluation.
+    #  @default: ` [ { "role": "system", "content": "You are an expert call evaluator.
+    #  You will be given a transcript of a call and the system prompt of the AI
+    #  participant. Determine if the call was successful based on the objectives
+    #  inferred from the system prompt. DO NOT return anything except the
+    #  result.\n\nRubric:\\n{{rubric}}\n\nOnly respond with the result." }, { "role":
+    #  "user", "content": "Here is the transcript:\n\n{{transcript}}\n\n" }, { "role":
+    #  "user", "content": "Here was the system prompt of the
+    #  call:\n\n{{systemPrompt}}\n\n" } ]`
+    #  You can customize by providing any messages you want.
+    #  Here are the template variables available:
+    #  - {{transcript}}: the transcript of the call from `call.artifact.transcript`-
+    #  {{systemPrompt}}: the system prompt of the call from
+    #  `assistant.model.messages[type=system].content`- {{rubric}}: the rubric of the
+    #  success evaluation from `successEvaluationPlan.rubric`
+    attr_reader :messages
+    # @return [Boolean] This determines whether a success evaluation is generated and stored in
+    #  `call.analysis.successEvaluation`. Defaults to true.
+    #  Usage:
+    #  - If you want to disable the success evaluation, set this to false.
+    #  @default true
+    attr_reader :enabled
+    # @return [Float] This is how long the request is tried before giving up. When request times out,
+    #  `call.analysis.successEvaluation` will be empty.
+    #  Usage:
+    #  - To guarantee the success evaluation is generated, set this value high. Note,
+    #  this will delay the end of call report in cases where model is slow to respond.
+    #  @default 5 seconds
+    attr_reader :timeout_seconds
+    # @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 rubric [Vapi::SuccessEvaluationPlanRubric] This enforces the rubric of the evaluation. The output is stored in
+    #  `call.analysis.successEvaluation`.
+    #  Options include:
+    #  - 'NumericScale': A scale of 1 to 10.
+    #  - 'DescriptiveScale': A scale of Excellent, Good, Fair, Poor.
+    #  - 'Checklist': A checklist of criteria and their status.
+    #  - 'Matrix': A grid that evaluates multiple criteria across different performance
+    #  levels.
+    #  - 'PercentageScale': A scale of 0% to 100%.
+    #  - 'LikertScale': A scale of Strongly Agree, Agree, Neutral, Disagree, Strongly
+    #  Disagree.
+    #  - 'AutomaticRubric': Automatically break down evaluation into several criteria,
+    #  each with its own score.
+    #  - 'PassFail': A simple 'true' if call passed, 'false' if not.
+    #  Default is 'PassFail'.
+    # @param messages [Array<Hash{String => Object}>] These are the messages used to generate the success evaluation.
+    #  @default: ` [ { "role": "system", "content": "You are an expert call evaluator.
+    #  You will be given a transcript of a call and the system prompt of the AI
+    #  participant. Determine if the call was successful based on the objectives
+    #  inferred from the system prompt. DO NOT return anything except the
+    #  result.\n\nRubric:\\n{{rubric}}\n\nOnly respond with the result." }, { "role":
+    #  "user", "content": "Here is the transcript:\n\n{{transcript}}\n\n" }, { "role":
+    #  "user", "content": "Here was the system prompt of the
+    #  call:\n\n{{systemPrompt}}\n\n" } ]`
+    #  You can customize by providing any messages you want.
+    #  Here are the template variables available:
+    #  - {{transcript}}: the transcript of the call from `call.artifact.transcript`-
+    #  {{systemPrompt}}: the system prompt of the call from
+    #  `assistant.model.messages[type=system].content`- {{rubric}}: the rubric of the
+    #  success evaluation from `successEvaluationPlan.rubric`
+    # @param enabled [Boolean] This determines whether a success evaluation is generated and stored in
+    #  `call.analysis.successEvaluation`. Defaults to true.
+    #  Usage:
+    #  - If you want to disable the success evaluation, set this to false.
+    #  @default true
+    # @param timeout_seconds [Float] This is how long the request is tried before giving up. When request times out,
+    #  `call.analysis.successEvaluation` will be empty.
+    #  Usage:
+    #  - To guarantee the success evaluation is generated, set this value high. Note,
+    #  this will delay the end of call report in cases where model is slow to respond.
+    #  @default 5 seconds
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::SuccessEvaluationPlan]
+    def initialize(rubric: OMIT, messages: OMIT, enabled: OMIT, timeout_seconds: OMIT, additional_properties: nil)
+      @rubric = rubric if rubric != OMIT
+      @messages = messages if messages != OMIT
+      @enabled = enabled if enabled != OMIT
+      @timeout_seconds = timeout_seconds if timeout_seconds != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "rubric": rubric,
+        "messages": messages,
+        "enabled": enabled,
+        "timeoutSeconds": timeout_seconds
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of SuccessEvaluationPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::SuccessEvaluationPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      rubric = parsed_json["rubric"]
+      messages = parsed_json["messages"]
+      enabled = parsed_json["enabled"]
+      timeout_seconds = parsed_json["timeoutSeconds"]
+      new(
+        rubric: rubric,
+        messages: messages,
+        enabled: enabled,
+        timeout_seconds: timeout_seconds,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of SuccessEvaluationPlan 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.rubric&.is_a?(Vapi::SuccessEvaluationPlanRubric) != false || raise("Passed value for field obj.rubric 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.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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/success_evaluation_plan_rubric.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This enforces the rubric of the evaluation. The output is stored in
+  #  `call.analysis.successEvaluation`.
+  #  Options include:
+  #  - 'NumericScale': A scale of 1 to 10.
+  #  - 'DescriptiveScale': A scale of Excellent, Good, Fair, Poor.
+  #  - 'Checklist': A checklist of criteria and their status.
+  #  - 'Matrix': A grid that evaluates multiple criteria across different performance
+  #  levels.
+  #  - 'PercentageScale': A scale of 0% to 100%.
+  #  - 'LikertScale': A scale of Strongly Agree, Agree, Neutral, Disagree, Strongly
+  #  Disagree.
+  #  - 'AutomaticRubric': Automatically break down evaluation into several criteria,
+  #  each with its own score.
+  #  - 'PassFail': A simple 'true' if call passed, 'false' if not.
+  #  Default is 'PassFail'.
+  class SuccessEvaluationPlanRubric
+    NUMERIC_SCALE = "NumericScale"
+    DESCRIPTIVE_SCALE = "DescriptiveScale"
+    CHECKLIST = "Checklist"
+    MATRIX = "Matrix"
+    PERCENTAGE_SCALE = "PercentageScale"
+    LIKERT_SCALE = "LikertScale"
+    AUTOMATIC_RUBRIC = "AutomaticRubric"
+    PASS_FAIL = "PassFail"
+  end
+end