vapi_server_sdk 0.1.0 → 0.3.0

data/lib/vapi_server_sdk/types/sip_authentication.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class SipAuthentication
+    # @return [String] This will be expected in the `realm` field of the `authorization` header of the
+    #  SIP INVITE. Defaults to sip.vapi.ai.
+    attr_reader :realm
+    # @return [String] This will be expected in the `username` field of the `authorization` header of
+    #  the SIP INVITE.
+    attr_reader :username
+    # @return [String] This will be expected to generate the `response` field of the `authorization`
+    #  header of the SIP INVITE, through digest authentication.
+    attr_reader :password
+    # @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 realm [String] This will be expected in the `realm` field of the `authorization` header of the
+    #  SIP INVITE. Defaults to sip.vapi.ai.
+    # @param username [String] This will be expected in the `username` field of the `authorization` header of
+    #  the SIP INVITE.
+    # @param password [String] This will be expected to generate the `response` field of the `authorization`
+    #  header of the SIP INVITE, through digest authentication.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::SipAuthentication]
+    def initialize(username:, password:, realm: OMIT, additional_properties: nil)
+      @realm = realm if realm != OMIT
+      @username = username
+      @password = password
+      @additional_properties = additional_properties
+      @_field_set = { "realm": realm, "username": username, "password": password }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of SipAuthentication
+    #
+    # @param json_object [String]
+    # @return [Vapi::SipAuthentication]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      realm = parsed_json["realm"]
+      username = parsed_json["username"]
+      password = parsed_json["password"]
+      new(
+        realm: realm,
+        username: username,
+        password: password,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of SipAuthentication 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.realm&.is_a?(String) != false || raise("Passed value for field obj.realm is not the expected type, validation failed.")
+      obj.username.is_a?(String) != false || raise("Passed value for field obj.username is not the expected type, validation failed.")
+      obj.password.is_a?(String) != false || raise("Passed value for field obj.password is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/smallest_ai_credential.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class SmallestAiCredential
+    # @return [String]
+    attr_reader :provider
+    # @return [String] This is not returned in the API.
+    attr_reader :api_key
+    # @return [String] This is the unique identifier for the credential.
+    attr_reader :id
+    # @return [String] This is the unique identifier for the org that this credential belongs to.
+    attr_reader :org_id
+    # @return [DateTime] This is the ISO 8601 date-time string of when the credential was created.
+    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]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param provider [String]
+    # @param api_key [String] This is not returned in the API.
+    # @param id [String] This is the unique identifier for the credential.
+    # @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::SmallestAiCredential]
+    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,
+        "apiKey": api_key,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at,
+        "name": name
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of SmallestAiCredential
+    #
+    # @param json_object [String]
+    # @return [Vapi::SmallestAiCredential]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      provider = parsed_json["provider"]
+      api_key = parsed_json["apiKey"]
+      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?)
+      name = parsed_json["name"]
+      new(
+        provider: provider,
+        api_key: api_key,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of SmallestAiCredential 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.api_key.is_a?(String) != false || raise("Passed value for field obj.api_key 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.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/smallest_ai_voice.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require_relative "smallest_ai_voice_id"
+require_relative "chunk_plan"
+require_relative "fallback_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class SmallestAiVoice
+    # @return [Vapi::SmallestAiVoiceId] This is the provider-specific ID that will be used.
+    attr_reader :voice_id
+    # @return [String] Smallest AI voice model to use. Defaults to 'lightning' when not specified.
+    attr_reader :model
+    # @return [Float] This is the speed multiplier that will be used.
+    attr_reader :speed
+    # @return [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
+    #  provider.
+    attr_reader :chunk_plan
+    # @return [Vapi::FallbackPlan] This is the plan for voice provider fallbacks in the event that the primary
+    #  voice provider fails.
+    attr_reader :fallback_plan
+    # @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 voice_id [Vapi::SmallestAiVoiceId] This is the provider-specific ID that will be used.
+    # @param model [String] Smallest AI voice model to use. Defaults to 'lightning' when not specified.
+    # @param speed [Float] This is the speed multiplier that will be used.
+    # @param chunk_plan [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
+    #  provider.
+    # @param fallback_plan [Vapi::FallbackPlan] This is the plan for voice provider fallbacks in the event that the primary
+    #  voice provider fails.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::SmallestAiVoice]
+    def initialize(voice_id:, model: OMIT, speed: OMIT, chunk_plan: OMIT, fallback_plan: OMIT,
+                   additional_properties: nil)
+      @voice_id = voice_id
+      @model = model if model != OMIT
+      @speed = speed if speed != OMIT
+      @chunk_plan = chunk_plan if chunk_plan != OMIT
+      @fallback_plan = fallback_plan if fallback_plan != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "voiceId": voice_id,
+        "model": model,
+        "speed": speed,
+        "chunkPlan": chunk_plan,
+        "fallbackPlan": fallback_plan
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of SmallestAiVoice
+    #
+    # @param json_object [String]
+    # @return [Vapi::SmallestAiVoice]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["voiceId"].nil?
+        voice_id = nil
+      else
+        voice_id = parsed_json["voiceId"].to_json
+        voice_id = Vapi::SmallestAiVoiceId.from_json(json_object: voice_id)
+      end
+      model = parsed_json["model"]
+      speed = parsed_json["speed"]
+      if parsed_json["chunkPlan"].nil?
+        chunk_plan = nil
+      else
+        chunk_plan = parsed_json["chunkPlan"].to_json
+        chunk_plan = Vapi::ChunkPlan.from_json(json_object: chunk_plan)
+      end
+      if parsed_json["fallbackPlan"].nil?
+        fallback_plan = nil
+      else
+        fallback_plan = parsed_json["fallbackPlan"].to_json
+        fallback_plan = Vapi::FallbackPlan.from_json(json_object: fallback_plan)
+      end
+      new(
+        voice_id: voice_id,
+        model: model,
+        speed: speed,
+        chunk_plan: chunk_plan,
+        fallback_plan: fallback_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of SmallestAiVoice 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:)
+      Vapi::SmallestAiVoiceId.validate_raw(obj: obj.voice_id)
+      obj.model&.is_a?(String) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
+      obj.speed&.is_a?(Float) != false || raise("Passed value for field obj.speed is not the expected type, validation failed.")
+      obj.chunk_plan.nil? || Vapi::ChunkPlan.validate_raw(obj: obj.chunk_plan)
+      obj.fallback_plan.nil? || Vapi::FallbackPlan.validate_raw(obj: obj.fallback_plan)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/smallest_ai_voice_id.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vapi
+  # This is the provider-specific ID that will be used.
+  class SmallestAiVoiceId
+    # Deserialize a JSON object to an instance of SmallestAiVoiceId
+    #
+    # @param json_object [String]
+    # @return [Vapi::SmallestAiVoiceId]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        struct.is_a?(Vapi::SmallestAiVoiceIdEnum) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+        return struct unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+        return struct unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      struct
+    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:)
+      begin
+        return obj.is_a?(Vapi::SmallestAiVoiceIdEnum) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+      rescue StandardError
+        # noop
+      end
+      begin
+        return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/smallest_ai_voice_id_enum.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Vapi
+  class SmallestAiVoiceIdEnum
+    EMILY = "emily"
+    JASMINE = "jasmine"
+    ARMAN = "arman"
+    JAMES = "james"
+    MITHALI = "mithali"
+    ARAVIND = "aravind"
+    RAJ = "raj"
+    DIYA = "diya"
+    RAMAN = "raman"
+    ANANYA = "ananya"
+    ISHA = "isha"
+    WILLIAM = "william"
+    AARAV = "aarav"
+    MONIKA = "monika"
+    NIHARIKA = "niharika"
+    DEEPIKA = "deepika"
+    RAGHAV = "raghav"
+    KAJAL = "kajal"
+    RADHIKA = "radhika"
+    MANSI = "mansi"
+    NISHA = "nisha"
+    SAURABH = "saurabh"
+    POOJA = "pooja"
+    SAINA = "saina"
+    SANYA = "sanya"
+  end
+end

data/lib/vapi_server_sdk/types/start_speaking_plan.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "start_speaking_plan_custom_endpointing_rules_item"
 require_relative "transcription_endpointing_plan"
 require "ostruct"
 require "json"
@@ -8,7 +9,7 @@ module Vapi
   class StartSpeakingPlan
     # @return [Float] This is how long assistant waits before speaking. Defaults to 0.4.
     #  This is the minimum it will wait but if there is latency is the pipeline, this
-    #  minimum will be exceeded. This is really a stopgap in case the pipeline is
+    #  minimum will be exceeded. This is intended as a stopgap in case the pipeline is
     #  moving too fast.
     #  Example:
     #  - If model generates tokens and voice generates bytes within 100ms, the pipeline
@@ -19,12 +20,30 @@ module Vapi
     #  value.
     #  @default 0.4
     attr_reader :wait_seconds
-    # @return [Boolean] This determines if a customer speech is considered done (endpointing) using the
-    #  VAP model on customer's speech. This is good for middle-of-thought detection.
+    # @return [Boolean] This determines if a customer speech is considered done (endpointing) using a
+    #  Vapi custom-trained model on customer's speech. This is good for
+    #  middle-of-thought detection.
     #  Once an endpoint is triggered, the request is sent to `assistant.model`.
-    #  Default `false` since experimental.
+    #  Usage:
+    #  - If your conversations are long-form and you want assistant to wait smartly
+    #  even if customer pauses for a bit to think, you can use this instead.
+    #  This overrides `transcriptionEndpointingPlan`.
     #  @default false
     attr_reader :smart_endpointing_enabled
+    # @return [Array<Vapi::StartSpeakingPlanCustomEndpointingRulesItem>] These are the custom endpointing rules to set an endpointing timeout based on a
+    #  regex on the customer's speech or the assistant's last message.
+    #  Usage:
+    #  - If you have yes/no questions like "are you interested in a loan?", you can set
+    #  a shorter timeout.
+    #  - If you have questions where the customer may pause to look up information like
+    #  "what's my account number?", you can set a longer timeout.
+    #  - If you want to wait longer while customer is enumerating a list of numbers,
+    #  you can set a longer timeout.
+    #  These override `transcriptionEndpointingPlan` and `smartEndpointingEnabled` when
+    #  a rule is matched.
+    #  The rules are evaluated in order and the first one that matches will be used.
+    #  @default []
+    attr_reader :custom_endpointing_rules
     # @return [Vapi::TranscriptionEndpointingPlan] This determines how a customer speech is considered done (endpointing) using the
     #  transcription of customer's speech.
     #  Once an endpoint is triggered, the request is sent to `assistant.model`.
@@ -39,7 +58,7 @@ module Vapi
 
     # @param wait_seconds [Float] This is how long assistant waits before speaking. Defaults to 0.4.
     #  This is the minimum it will wait but if there is latency is the pipeline, this
-    #  minimum will be exceeded. This is really a stopgap in case the pipeline is
+    #  minimum will be exceeded. This is intended as a stopgap in case the pipeline is
     #  moving too fast.
     #  Example:
     #  - If model generates tokens and voice generates bytes within 100ms, the pipeline
@@ -49,25 +68,44 @@ module Vapi
     #  - If the assistant is accidentally jumping in too much, set this to a higher
     #  value.
     #  @default 0.4
-    # @param smart_endpointing_enabled [Boolean] This determines if a customer speech is considered done (endpointing) using the
-    #  VAP model on customer's speech. This is good for middle-of-thought detection.
+    # @param smart_endpointing_enabled [Boolean] This determines if a customer speech is considered done (endpointing) using a
+    #  Vapi custom-trained model on customer's speech. This is good for
+    #  middle-of-thought detection.
     #  Once an endpoint is triggered, the request is sent to `assistant.model`.
-    #  Default `false` since experimental.
+    #  Usage:
+    #  - If your conversations are long-form and you want assistant to wait smartly
+    #  even if customer pauses for a bit to think, you can use this instead.
+    #  This overrides `transcriptionEndpointingPlan`.
     #  @default false
+    # @param custom_endpointing_rules [Array<Vapi::StartSpeakingPlanCustomEndpointingRulesItem>] These are the custom endpointing rules to set an endpointing timeout based on a
+    #  regex on the customer's speech or the assistant's last message.
+    #  Usage:
+    #  - If you have yes/no questions like "are you interested in a loan?", you can set
+    #  a shorter timeout.
+    #  - If you have questions where the customer may pause to look up information like
+    #  "what's my account number?", you can set a longer timeout.
+    #  - If you want to wait longer while customer is enumerating a list of numbers,
+    #  you can set a longer timeout.
+    #  These override `transcriptionEndpointingPlan` and `smartEndpointingEnabled` when
+    #  a rule is matched.
+    #  The rules are evaluated in order and the first one that matches will be used.
+    #  @default []
     # @param transcription_endpointing_plan [Vapi::TranscriptionEndpointingPlan] This determines how a customer speech is considered done (endpointing) using the
     #  transcription of customer's speech.
     #  Once an endpoint is triggered, the request is sent to `assistant.model`.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::StartSpeakingPlan]
-    def initialize(wait_seconds: OMIT, smart_endpointing_enabled: OMIT, transcription_endpointing_plan: OMIT,
-                   additional_properties: nil)
+    def initialize(wait_seconds: OMIT, smart_endpointing_enabled: OMIT, custom_endpointing_rules: OMIT,
+                   transcription_endpointing_plan: OMIT, additional_properties: nil)
       @wait_seconds = wait_seconds if wait_seconds != OMIT
       @smart_endpointing_enabled = smart_endpointing_enabled if smart_endpointing_enabled != OMIT
+      @custom_endpointing_rules = custom_endpointing_rules if custom_endpointing_rules != OMIT
       @transcription_endpointing_plan = transcription_endpointing_plan if transcription_endpointing_plan != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "waitSeconds": wait_seconds,
         "smartEndpointingEnabled": smart_endpointing_enabled,
+        "customEndpointingRules": custom_endpointing_rules,
         "transcriptionEndpointingPlan": transcription_endpointing_plan
       }.reject do |_k, v|
         v == OMIT
@@ -83,6 +121,10 @@ module Vapi
       parsed_json = JSON.parse(json_object)
       wait_seconds = parsed_json["waitSeconds"]
       smart_endpointing_enabled = parsed_json["smartEndpointingEnabled"]
+      custom_endpointing_rules = parsed_json["customEndpointingRules"]&.map do |item|
+        item = item.to_json
+        Vapi::StartSpeakingPlanCustomEndpointingRulesItem.from_json(json_object: item)
+      end
       if parsed_json["transcriptionEndpointingPlan"].nil?
         transcription_endpointing_plan = nil
       else
@@ -92,6 +134,7 @@ module Vapi
       new(
         wait_seconds: wait_seconds,
         smart_endpointing_enabled: smart_endpointing_enabled,
+        custom_endpointing_rules: custom_endpointing_rules,
         transcription_endpointing_plan: transcription_endpointing_plan,
         additional_properties: struct
       )
@@ -113,6 +156,7 @@ module Vapi
     def self.validate_raw(obj:)
       obj.wait_seconds&.is_a?(Float) != false || raise("Passed value for field obj.wait_seconds is not the expected type, validation failed.")
       obj.smart_endpointing_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.smart_endpointing_enabled is not the expected type, validation failed.")
+      obj.custom_endpointing_rules&.is_a?(Array) != false || raise("Passed value for field obj.custom_endpointing_rules is not the expected type, validation failed.")
       obj.transcription_endpointing_plan.nil? || Vapi::TranscriptionEndpointingPlan.validate_raw(obj: obj.transcription_endpointing_plan)
     end
   end

data/lib/vapi_server_sdk/types/start_speaking_plan_custom_endpointing_rules_item.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "assistant_custom_endpointing_rule"
+require_relative "customer_custom_endpointing_rule"
+require_relative "both_custom_endpointing_rule"
+
+module Vapi
+  class StartSpeakingPlanCustomEndpointingRulesItem
+    # @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::StartSpeakingPlanCustomEndpointingRulesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  StartSpeakingPlanCustomEndpointingRulesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::StartSpeakingPlanCustomEndpointingRulesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "assistant"
+                 Vapi::AssistantCustomEndpointingRule.from_json(json_object: json_object)
+               when "customer"
+                 Vapi::CustomerCustomEndpointingRule.from_json(json_object: json_object)
+               when "both"
+                 Vapi::BothCustomEndpointingRule.from_json(json_object: json_object)
+               else
+                 Vapi::AssistantCustomEndpointingRule.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 "assistant"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "customer"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "both"
+        { **@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 "assistant"
+        Vapi::AssistantCustomEndpointingRule.validate_raw(obj: obj)
+      when "customer"
+        Vapi::CustomerCustomEndpointingRule.validate_raw(obj: obj)
+      when "both"
+        Vapi::BothCustomEndpointingRule.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::AssistantCustomEndpointingRule]
+    # @return [Vapi::StartSpeakingPlanCustomEndpointingRulesItem]
+    def self.assistant(member:)
+      new(member: member, discriminant: "assistant")
+    end
+
+    # @param member [Vapi::CustomerCustomEndpointingRule]
+    # @return [Vapi::StartSpeakingPlanCustomEndpointingRulesItem]
+    def self.customer(member:)
+      new(member: member, discriminant: "customer")
+    end
+
+    # @param member [Vapi::BothCustomEndpointingRule]
+    # @return [Vapi::StartSpeakingPlanCustomEndpointingRulesItem]
+    def self.both(member:)
+      new(member: member, discriminant: "both")
+    end
+  end
+end