vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/sip_trunk_gateway.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require_relative "sip_trunk_gateway_outbound_protocol"
+require "ostruct"
+require "json"
+
+module Vapi
+  class SipTrunkGateway
+    # @return [String] This is the address of the gateway. It can be an IPv4 address like 1.1.1.1 or a
+    #  fully qualified domain name like my-sip-trunk.pstn.twilio.com.
+    attr_reader :ip
+    # @return [Float] This is the port number of the gateway. Default is 5060.
+    #  @default 5060
+    attr_reader :port
+    # @return [Float] This is the netmask of the gateway. Defaults to 32.
+    #  @default 32
+    attr_reader :netmask
+    # @return [Boolean] This is whether inbound calls are allowed from this gateway. Default is true.
+    #  @default true
+    attr_reader :inbound_enabled
+    # @return [Boolean] This is whether outbound calls should be sent to this gateway. Default is true.
+    #  Note, if netmask is less than 32, it doesn't affect the outbound IPs that are
+    #  tried. 1 attempt is made to `ip:port`.
+    #  @default true
+    attr_reader :outbound_enabled
+    # @return [Vapi::SipTrunkGatewayOutboundProtocol] This is the protocol to use for SIP signaling outbound calls. Default is udp.
+    #  @default udp
+    attr_reader :outbound_protocol
+    # @return [Boolean] This is whether to send options ping to the gateway. This can be used to check
+    #  if the gateway is reachable. Default is false.
+    #  This is useful for high availability setups where you want to check if the
+    #  gateway is reachable before routing calls to it. Note, if no gateway for a trunk
+    #  is reachable, outbound calls will be rejected.
+    #  @default false
+    attr_reader :options_ping_enabled
+    # @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 ip [String] This is the address of the gateway. It can be an IPv4 address like 1.1.1.1 or a
+    #  fully qualified domain name like my-sip-trunk.pstn.twilio.com.
+    # @param port [Float] This is the port number of the gateway. Default is 5060.
+    #  @default 5060
+    # @param netmask [Float] This is the netmask of the gateway. Defaults to 32.
+    #  @default 32
+    # @param inbound_enabled [Boolean] This is whether inbound calls are allowed from this gateway. Default is true.
+    #  @default true
+    # @param outbound_enabled [Boolean] This is whether outbound calls should be sent to this gateway. Default is true.
+    #  Note, if netmask is less than 32, it doesn't affect the outbound IPs that are
+    #  tried. 1 attempt is made to `ip:port`.
+    #  @default true
+    # @param outbound_protocol [Vapi::SipTrunkGatewayOutboundProtocol] This is the protocol to use for SIP signaling outbound calls. Default is udp.
+    #  @default udp
+    # @param options_ping_enabled [Boolean] This is whether to send options ping to the gateway. This can be used to check
+    #  if the gateway is reachable. Default is false.
+    #  This is useful for high availability setups where you want to check if the
+    #  gateway is reachable before routing calls to it. Note, if no gateway for a trunk
+    #  is reachable, outbound calls will be rejected.
+    #  @default false
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::SipTrunkGateway]
+    def initialize(ip:, port: OMIT, netmask: OMIT, inbound_enabled: OMIT, outbound_enabled: OMIT,
+                   outbound_protocol: OMIT, options_ping_enabled: OMIT, additional_properties: nil)
+      @ip = ip
+      @port = port if port != OMIT
+      @netmask = netmask if netmask != OMIT
+      @inbound_enabled = inbound_enabled if inbound_enabled != OMIT
+      @outbound_enabled = outbound_enabled if outbound_enabled != OMIT
+      @outbound_protocol = outbound_protocol if outbound_protocol != OMIT
+      @options_ping_enabled = options_ping_enabled if options_ping_enabled != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "ip": ip,
+        "port": port,
+        "netmask": netmask,
+        "inboundEnabled": inbound_enabled,
+        "outboundEnabled": outbound_enabled,
+        "outboundProtocol": outbound_protocol,
+        "optionsPingEnabled": options_ping_enabled
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of SipTrunkGateway
+    #
+    # @param json_object [String]
+    # @return [Vapi::SipTrunkGateway]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      ip = parsed_json["ip"]
+      port = parsed_json["port"]
+      netmask = parsed_json["netmask"]
+      inbound_enabled = parsed_json["inboundEnabled"]
+      outbound_enabled = parsed_json["outboundEnabled"]
+      outbound_protocol = parsed_json["outboundProtocol"]
+      options_ping_enabled = parsed_json["optionsPingEnabled"]
+      new(
+        ip: ip,
+        port: port,
+        netmask: netmask,
+        inbound_enabled: inbound_enabled,
+        outbound_enabled: outbound_enabled,
+        outbound_protocol: outbound_protocol,
+        options_ping_enabled: options_ping_enabled,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of SipTrunkGateway 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.ip.is_a?(String) != false || raise("Passed value for field obj.ip is not the expected type, validation failed.")
+      obj.port&.is_a?(Float) != false || raise("Passed value for field obj.port is not the expected type, validation failed.")
+      obj.netmask&.is_a?(Float) != false || raise("Passed value for field obj.netmask is not the expected type, validation failed.")
+      obj.inbound_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.inbound_enabled is not the expected type, validation failed.")
+      obj.outbound_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.outbound_enabled is not the expected type, validation failed.")
+      obj.outbound_protocol&.is_a?(Vapi::SipTrunkGatewayOutboundProtocol) != false || raise("Passed value for field obj.outbound_protocol is not the expected type, validation failed.")
+      obj.options_ping_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.options_ping_enabled is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/sip_trunk_gateway_outbound_protocol.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the protocol to use for SIP signaling outbound calls. Default is udp.
+  #  @default udp
+  class SipTrunkGatewayOutboundProtocol
+    TLS_SRTP = "tls/srtp"
+    TCP = "tcp"
+    TLS = "tls"
+    UDP = "udp"
+  end
+end

data/lib/vapi_server_sdk/types/sip_trunk_outbound_authentication_plan.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative "sip_trunk_outbound_sip_register_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class SipTrunkOutboundAuthenticationPlan
+    # @return [String] This is not returned in the API.
+    attr_reader :auth_password
+    # @return [String]
+    attr_reader :auth_username
+    # @return [Vapi::SipTrunkOutboundSipRegisterPlan] This can be used to configure if SIP register is required by the SIP trunk. If
+    #  not provided, no SIP registration will be attempted.
+    attr_reader :sip_register_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 auth_password [String] This is not returned in the API.
+    # @param auth_username [String]
+    # @param sip_register_plan [Vapi::SipTrunkOutboundSipRegisterPlan] This can be used to configure if SIP register is required by the SIP trunk. If
+    #  not provided, no SIP registration will be attempted.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::SipTrunkOutboundAuthenticationPlan]
+    def initialize(auth_password: OMIT, auth_username: OMIT, sip_register_plan: OMIT, additional_properties: nil)
+      @auth_password = auth_password if auth_password != OMIT
+      @auth_username = auth_username if auth_username != OMIT
+      @sip_register_plan = sip_register_plan if sip_register_plan != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "authPassword": auth_password,
+        "authUsername": auth_username,
+        "sipRegisterPlan": sip_register_plan
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of SipTrunkOutboundAuthenticationPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::SipTrunkOutboundAuthenticationPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      auth_password = parsed_json["authPassword"]
+      auth_username = parsed_json["authUsername"]
+      if parsed_json["sipRegisterPlan"].nil?
+        sip_register_plan = nil
+      else
+        sip_register_plan = parsed_json["sipRegisterPlan"].to_json
+        sip_register_plan = Vapi::SipTrunkOutboundSipRegisterPlan.from_json(json_object: sip_register_plan)
+      end
+      new(
+        auth_password: auth_password,
+        auth_username: auth_username,
+        sip_register_plan: sip_register_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of SipTrunkOutboundAuthenticationPlan 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.auth_password&.is_a?(String) != false || raise("Passed value for field obj.auth_password is not the expected type, validation failed.")
+      obj.auth_username&.is_a?(String) != false || raise("Passed value for field obj.auth_username is not the expected type, validation failed.")
+      obj.sip_register_plan.nil? || Vapi::SipTrunkOutboundSipRegisterPlan.validate_raw(obj: obj.sip_register_plan)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/sip_trunk_outbound_sip_register_plan.rb

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

data/lib/vapi_server_sdk/types/squad.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require_relative "squad_member_dto"
+require_relative "assistant_overrides"
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class Squad
+    # @return [String] This is the name of the squad.
+    attr_reader :name
+    # @return [Array<Vapi::SquadMemberDto>] This is the list of assistants that make up the squad.
+    #  The call will start with the first assistant in the list.
+    attr_reader :members
+    # @return [Vapi::AssistantOverrides] This can be used to override all the assistants' settings and provide values for
+    #  their template variables.
+    #  Both `membersOverrides` and `members[n].assistantOverrides` can be used
+    #  together. First, `members[n].assistantOverrides` is applied. Then,
+    #  `membersOverrides` is applied as a global override.
+    attr_reader :members_overrides
+    # @return [String] This is the unique identifier for the squad.
+    attr_reader :id
+    # @return [String] This is the unique identifier for the org that this squad belongs to.
+    attr_reader :org_id
+    # @return [DateTime] This is the ISO 8601 date-time string of when the squad was created.
+    attr_reader :created_at
+    # @return [DateTime] This is the ISO 8601 date-time string of when the squad was last updated.
+    attr_reader :updated_at
+    # @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] This is the name of the squad.
+    # @param members [Array<Vapi::SquadMemberDto>] This is the list of assistants that make up the squad.
+    #  The call will start with the first assistant in the list.
+    # @param members_overrides [Vapi::AssistantOverrides] This can be used to override all the assistants' settings and provide values for
+    #  their template variables.
+    #  Both `membersOverrides` and `members[n].assistantOverrides` can be used
+    #  together. First, `members[n].assistantOverrides` is applied. Then,
+    #  `membersOverrides` is applied as a global override.
+    # @param id [String] This is the unique identifier for the squad.
+    # @param org_id [String] This is the unique identifier for the org that this squad belongs to.
+    # @param created_at [DateTime] This is the ISO 8601 date-time string of when the squad was created.
+    # @param updated_at [DateTime] This is the ISO 8601 date-time string of when the squad was last updated.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::Squad]
+    def initialize(members:, id:, org_id:, created_at:, updated_at:, name: OMIT, members_overrides: OMIT,
+                   additional_properties: nil)
+      @name = name if name != OMIT
+      @members = members
+      @members_overrides = members_overrides if members_overrides != OMIT
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @additional_properties = additional_properties
+      @_field_set = {
+        "name": name,
+        "members": members,
+        "membersOverrides": members_overrides,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of Squad
+    #
+    # @param json_object [String]
+    # @return [Vapi::Squad]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      members = parsed_json["members"]&.map do |item|
+        item = item.to_json
+        Vapi::SquadMemberDto.from_json(json_object: item)
+      end
+      if parsed_json["membersOverrides"].nil?
+        members_overrides = nil
+      else
+        members_overrides = parsed_json["membersOverrides"].to_json
+        members_overrides = Vapi::AssistantOverrides.from_json(json_object: members_overrides)
+      end
+      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?)
+      new(
+        name: name,
+        members: members,
+        members_overrides: members_overrides,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of Squad 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.members.is_a?(Array) != false || raise("Passed value for field obj.members is not the expected type, validation failed.")
+      obj.members_overrides.nil? || Vapi::AssistantOverrides.validate_raw(obj: obj.members_overrides)
+      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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/squad_member_dto.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require_relative "create_assistant_dto"
+require_relative "assistant_overrides"
+require_relative "transfer_destination_assistant"
+require "ostruct"
+require "json"
+
+module Vapi
+  class SquadMemberDto
+    # @return [String] This is the assistant that will be used for the call. To use a transient
+    #  assistant, use `assistant` instead.
+    attr_reader :assistant_id
+    # @return [Vapi::CreateAssistantDto] This is the assistant that will be used for the call. To use an existing
+    #  assistant, use `assistantId` instead.
+    attr_reader :assistant
+    # @return [Vapi::AssistantOverrides] This can be used to override the assistant's settings and provide values for
+    #  it's template variables.
+    attr_reader :assistant_overrides
+    # @return [Array<Vapi::TransferDestinationAssistant>] These are the others assistants that this assistant can transfer to.
+    #  If the assistant already has transfer call tool, these destinations are just
+    #  appended to existing ones.
+    attr_reader :assistant_destinations
+    # @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 assistant_id [String] This is the assistant that will be used for the call. To use a transient
+    #  assistant, use `assistant` instead.
+    # @param assistant [Vapi::CreateAssistantDto] This is the assistant that will be used for the call. To use an existing
+    #  assistant, use `assistantId` instead.
+    # @param assistant_overrides [Vapi::AssistantOverrides] This can be used to override the assistant's settings and provide values for
+    #  it's template variables.
+    # @param assistant_destinations [Array<Vapi::TransferDestinationAssistant>] These are the others assistants that this assistant can transfer to.
+    #  If the assistant already has transfer call tool, these destinations are just
+    #  appended to existing ones.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::SquadMemberDto]
+    def initialize(assistant_id: OMIT, assistant: OMIT, assistant_overrides: OMIT, assistant_destinations: OMIT,
+                   additional_properties: nil)
+      @assistant_id = assistant_id if assistant_id != OMIT
+      @assistant = assistant if assistant != OMIT
+      @assistant_overrides = assistant_overrides if assistant_overrides != OMIT
+      @assistant_destinations = assistant_destinations if assistant_destinations != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "assistantId": assistant_id,
+        "assistant": assistant,
+        "assistantOverrides": assistant_overrides,
+        "assistantDestinations": assistant_destinations
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of SquadMemberDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::SquadMemberDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      assistant_id = parsed_json["assistantId"]
+      if parsed_json["assistant"].nil?
+        assistant = nil
+      else
+        assistant = parsed_json["assistant"].to_json
+        assistant = Vapi::CreateAssistantDto.from_json(json_object: assistant)
+      end
+      if parsed_json["assistantOverrides"].nil?
+        assistant_overrides = nil
+      else
+        assistant_overrides = parsed_json["assistantOverrides"].to_json
+        assistant_overrides = Vapi::AssistantOverrides.from_json(json_object: assistant_overrides)
+      end
+      assistant_destinations = parsed_json["assistantDestinations"]&.map do |item|
+        item = item.to_json
+        Vapi::TransferDestinationAssistant.from_json(json_object: item)
+      end
+      new(
+        assistant_id: assistant_id,
+        assistant: assistant,
+        assistant_overrides: assistant_overrides,
+        assistant_destinations: assistant_destinations,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of SquadMemberDto 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.assistant_id&.is_a?(String) != false || raise("Passed value for field obj.assistant_id is not the expected type, validation failed.")
+      obj.assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.assistant)
+      obj.assistant_overrides.nil? || Vapi::AssistantOverrides.validate_raw(obj: obj.assistant_overrides)
+      obj.assistant_destinations&.is_a?(Array) != false || raise("Passed value for field obj.assistant_destinations is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/start_speaking_plan.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require_relative "transcription_endpointing_plan"
+require "ostruct"
+require "json"
+
+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
+    #  moving too fast.
+    #  Example:
+    #  - If model generates tokens and voice generates bytes within 100ms, the pipeline
+    #  still waits 300ms before outputting speech.
+    #  Usage:
+    #  - If the customer is taking long pauses, set this to a higher value.
+    #  - If the assistant is accidentally jumping in too much, set this to a higher
+    #  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.
+    #  Once an endpoint is triggered, the request is sent to `assistant.model`.
+    #  Default `false` since experimental.
+    #  @default false
+    attr_reader :smart_endpointing_enabled
+    # @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`.
+    attr_reader :transcription_endpointing_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 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
+    #  moving too fast.
+    #  Example:
+    #  - If model generates tokens and voice generates bytes within 100ms, the pipeline
+    #  still waits 300ms before outputting speech.
+    #  Usage:
+    #  - If the customer is taking long pauses, set this to a higher value.
+    #  - 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.
+    #  Once an endpoint is triggered, the request is sent to `assistant.model`.
+    #  Default `false` since experimental.
+    #  @default false
+    # @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)
+      @wait_seconds = wait_seconds if wait_seconds != OMIT
+      @smart_endpointing_enabled = smart_endpointing_enabled if smart_endpointing_enabled != 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,
+        "transcriptionEndpointingPlan": transcription_endpointing_plan
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of StartSpeakingPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::StartSpeakingPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      wait_seconds = parsed_json["waitSeconds"]
+      smart_endpointing_enabled = parsed_json["smartEndpointingEnabled"]
+      if parsed_json["transcriptionEndpointingPlan"].nil?
+        transcription_endpointing_plan = nil
+      else
+        transcription_endpointing_plan = parsed_json["transcriptionEndpointingPlan"].to_json
+        transcription_endpointing_plan = Vapi::TranscriptionEndpointingPlan.from_json(json_object: transcription_endpointing_plan)
+      end
+      new(
+        wait_seconds: wait_seconds,
+        smart_endpointing_enabled: smart_endpointing_enabled,
+        transcription_endpointing_plan: transcription_endpointing_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of StartSpeakingPlan 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.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.transcription_endpointing_plan.nil? || Vapi::TranscriptionEndpointingPlan.validate_raw(obj: obj.transcription_endpointing_plan)
+    end
+  end
+end