vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/fallback_vapi_voice.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative "fallback_vapi_voice_voice_id"
+require_relative "chunk_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class FallbackVapiVoice
+    # @return [Boolean] This is the flag to toggle voice caching for the assistant.
+    attr_reader :caching_enabled
+    # @return [Vapi::FallbackVapiVoiceVoiceId] The voices provided by Vapi
+    attr_reader :voice_id
+    # @return [Float] This is the speed multiplier that will be used.
+    #  @default 1
+    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 [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 caching_enabled [Boolean] This is the flag to toggle voice caching for the assistant.
+    # @param voice_id [Vapi::FallbackVapiVoiceVoiceId] The voices provided by Vapi
+    # @param speed [Float] This is the speed multiplier that will be used.
+    #  @default 1
+    # @param chunk_plan [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
+    #  provider.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::FallbackVapiVoice]
+    def initialize(voice_id:, caching_enabled: OMIT, speed: OMIT, chunk_plan: OMIT, additional_properties: nil)
+      @caching_enabled = caching_enabled if caching_enabled != OMIT
+      @voice_id = voice_id
+      @speed = speed if speed != OMIT
+      @chunk_plan = chunk_plan if chunk_plan != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "cachingEnabled": caching_enabled,
+        "voiceId": voice_id,
+        "speed": speed,
+        "chunkPlan": chunk_plan
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of FallbackVapiVoice
+    #
+    # @param json_object [String]
+    # @return [Vapi::FallbackVapiVoice]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      caching_enabled = parsed_json["cachingEnabled"]
+      voice_id = parsed_json["voiceId"]
+      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
+      new(
+        caching_enabled: caching_enabled,
+        voice_id: voice_id,
+        speed: speed,
+        chunk_plan: chunk_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FallbackVapiVoice 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.caching_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.caching_enabled is not the expected type, validation failed.")
+      obj.voice_id.is_a?(Vapi::FallbackVapiVoiceVoiceId) != false || raise("Passed value for field obj.voice_id 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)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/fallback_vapi_voice_voice_id.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Vapi
+  # The voices provided by Vapi
+  class FallbackVapiVoiceVoiceId
+    ELLIOT = "Elliot"
+    KYLIE = "Kylie"
+    ROHAN = "Rohan"
+    LILY = "Lily"
+    SAVANNAH = "Savannah"
+    HANA = "Hana"
+    NEHA = "Neha"
+    COLE = "Cole"
+    HARRY = "Harry"
+    PAIGE = "Paige"
+    SPENCER = "Spencer"
+  end
+end

data/lib/vapi_server_sdk/types/file.rb

@@ -29,6 +29,10 @@ module Vapi
     attr_reader :bucket
     # @return [String]
     attr_reader :url
+    # @return [String]
+    attr_reader :parsed_text_url
+    # @return [Float]
+    attr_reader :parsed_text_bytes
     # @return [Hash{String => Object}]
     attr_reader :metadata
     # @return [String] This is the unique identifier for the file.
@@ -58,6 +62,8 @@ module Vapi
     # @param path [String]
     # @param bucket [String]
     # @param url [String]
+    # @param parsed_text_url [String]
+    # @param parsed_text_bytes [Float]
     # @param metadata [Hash{String => Object}]
     # @param id [String] This is the unique identifier for the file.
     # @param org_id [String] This is the unique identifier for the org that this file belongs to.
@@ -66,7 +72,7 @@ module Vapi
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::File]
     def initialize(id:, org_id:, created_at:, updated_at:, object: OMIT, status: OMIT, name: OMIT, original_name: OMIT, bytes: OMIT, purpose: OMIT,
-                   mimetype: OMIT, key: OMIT, path: OMIT, bucket: OMIT, url: OMIT, metadata: OMIT, additional_properties: nil)
+                   mimetype: OMIT, key: OMIT, path: OMIT, bucket: OMIT, url: OMIT, parsed_text_url: OMIT, parsed_text_bytes: OMIT, metadata: OMIT, additional_properties: nil)
       @object = object if object != OMIT
       @status = status if status != OMIT
       @name = name if name != OMIT
@@ -78,6 +84,8 @@ module Vapi
       @path = path if path != OMIT
       @bucket = bucket if bucket != OMIT
       @url = url if url != OMIT
+      @parsed_text_url = parsed_text_url if parsed_text_url != OMIT
+      @parsed_text_bytes = parsed_text_bytes if parsed_text_bytes != OMIT
       @metadata = metadata if metadata != OMIT
       @id = id
       @org_id = org_id
@@ -96,6 +104,8 @@ module Vapi
         "path": path,
         "bucket": bucket,
         "url": url,
+        "parsedTextUrl": parsed_text_url,
+        "parsedTextBytes": parsed_text_bytes,
         "metadata": metadata,
         "id": id,
         "orgId": org_id,
@@ -124,6 +134,8 @@ module Vapi
       path = parsed_json["path"]
       bucket = parsed_json["bucket"]
       url = parsed_json["url"]
+      parsed_text_url = parsed_json["parsedTextUrl"]
+      parsed_text_bytes = parsed_json["parsedTextBytes"]
       metadata = parsed_json["metadata"]
       id = parsed_json["id"]
       org_id = parsed_json["orgId"]
@@ -141,6 +153,8 @@ module Vapi
         path: path,
         bucket: bucket,
         url: url,
+        parsed_text_url: parsed_text_url,
+        parsed_text_bytes: parsed_text_bytes,
         metadata: metadata,
         id: id,
         org_id: org_id,
@@ -175,6 +189,8 @@ module Vapi
       obj.path&.is_a?(String) != false || raise("Passed value for field obj.path is not the expected type, validation failed.")
       obj.bucket&.is_a?(String) != false || raise("Passed value for field obj.bucket is not the expected type, validation failed.")
       obj.url&.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+      obj.parsed_text_url&.is_a?(String) != false || raise("Passed value for field obj.parsed_text_url is not the expected type, validation failed.")
+      obj.parsed_text_bytes&.is_a?(Float) != false || raise("Passed value for field obj.parsed_text_bytes is not the expected type, validation failed.")
       obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
       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.")

data/lib/vapi_server_sdk/types/file_status.rb

@@ -2,7 +2,8 @@
 
 module Vapi
   class FileStatus
-    INDEXED = "indexed"
-    NOT_INDEXED = "not_indexed"
+    PROCESSING = "processing"
+    DONE = "done"
+    FAILED = "failed"
   end
 end

data/lib/vapi_server_sdk/types/format_plan.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "format_plan_replacements_item"
+require_relative "format_plan_formatters_enabled_item"
 require "ostruct"
 require "json"
 
@@ -35,6 +36,13 @@ module Vapi
     #  type. Eg. `{ type: 'regex', regex: '\\b[a-zA-Z]{5}\\b', value: 'hi' }`
     #  @default []
     attr_reader :replacements
+    # @return [Array<Vapi::FormatPlanFormattersEnabledItem>] List of formatters to apply. If not provided, all default formatters will be
+    #  applied.
+    #  If provided, only the specified formatters will be applied.
+    #  Note: Some essential formatters like angle bracket removal will always be
+    #  applied.
+    #  @default undefined
+    attr_reader :formatters_enabled
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -69,17 +77,26 @@ module Vapi
     #  - To replace a word or phrase that matches a pattern, use the `RegexReplacement`
     #  type. Eg. `{ type: 'regex', regex: '\\b[a-zA-Z]{5}\\b', value: 'hi' }`
     #  @default []
+    # @param formatters_enabled [Array<Vapi::FormatPlanFormattersEnabledItem>] List of formatters to apply. If not provided, all default formatters will be
+    #  applied.
+    #  If provided, only the specified formatters will be applied.
+    #  Note: Some essential formatters like angle bracket removal will always be
+    #  applied.
+    #  @default undefined
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::FormatPlan]
-    def initialize(enabled: OMIT, number_to_digits_cutoff: OMIT, replacements: OMIT, additional_properties: nil)
+    def initialize(enabled: OMIT, number_to_digits_cutoff: OMIT, replacements: OMIT, formatters_enabled: OMIT,
+                   additional_properties: nil)
       @enabled = enabled if enabled != OMIT
       @number_to_digits_cutoff = number_to_digits_cutoff if number_to_digits_cutoff != OMIT
       @replacements = replacements if replacements != OMIT
+      @formatters_enabled = formatters_enabled if formatters_enabled != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "enabled": enabled,
         "numberToDigitsCutoff": number_to_digits_cutoff,
-        "replacements": replacements
+        "replacements": replacements,
+        "formattersEnabled": formatters_enabled
       }.reject do |_k, v|
         v == OMIT
       end
@@ -98,10 +115,12 @@ module Vapi
         item = item.to_json
         Vapi::FormatPlanReplacementsItem.from_json(json_object: item)
       end
+      formatters_enabled = parsed_json["formattersEnabled"]
       new(
         enabled: enabled,
         number_to_digits_cutoff: number_to_digits_cutoff,
         replacements: replacements,
+        formatters_enabled: formatters_enabled,
         additional_properties: struct
       )
     end
@@ -123,6 +142,7 @@ module Vapi
       obj.enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.enabled is not the expected type, validation failed.")
       obj.number_to_digits_cutoff&.is_a?(Float) != false || raise("Passed value for field obj.number_to_digits_cutoff is not the expected type, validation failed.")
       obj.replacements&.is_a?(Array) != false || raise("Passed value for field obj.replacements is not the expected type, validation failed.")
+      obj.formatters_enabled&.is_a?(Array) != false || raise("Passed value for field obj.formatters_enabled is not the expected type, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/format_plan_formatters_enabled_item.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Vapi
+  class FormatPlanFormattersEnabledItem
+    MARKDOWN = "markdown"
+    ASTERISK = "asterisk"
+    QUOTE = "quote"
+    DASH = "dash"
+    NEWLINE = "newline"
+    COLON = "colon"
+    ACRONYM = "acronym"
+    DOLLAR_AMOUNT = "dollarAmount"
+    EMAIL = "email"
+    DATE = "date"
+    TIME = "time"
+    DISTANCE = "distance"
+    UNIT = "unit"
+    PERCENTAGE = "percentage"
+    PHONE_NUMBER = "phoneNumber"
+    NUMBER = "number"
+    STRIP_ASTERISK = "stripAsterisk"
+  end
+end

data/lib/vapi_server_sdk/types/fourier_denoising_plan.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class FourierDenoisingPlan
+    # @return [Boolean] Whether Fourier denoising is enabled. Note that this is experimental and may not
+    #  work as expected.
+    attr_reader :enabled
+    # @return [Boolean] Whether automatic media detection is enabled. When enabled, the filter will
+    #  automatically
+    #  detect consistent background TV/music/radio and switch to more aggressive
+    #  filtering settings.
+    #  Only applies when enabled is true.
+    attr_reader :media_detection_enabled
+    # @return [Float] Static threshold in dB used as fallback when no baseline is established.
+    attr_reader :static_threshold
+    # @return [Float] How far below the rolling baseline to filter audio, in dB.
+    #  Lower values (e.g., -10) are more aggressive, higher values (e.g., -20) are more
+    #  conservative.
+    attr_reader :baseline_offset_db
+    # @return [Float] Rolling window size in milliseconds for calculating the audio baseline.
+    #  Larger windows adapt more slowly but are more stable.
+    attr_reader :window_size_ms
+    # @return [Float] Percentile to use for baseline calculation (1-99).
+    #  Higher percentiles (e.g., 85) focus on louder speech, lower percentiles (e.g.,
+    #  50) include quieter speech.
+    attr_reader :baseline_percentile
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param enabled [Boolean] Whether Fourier denoising is enabled. Note that this is experimental and may not
+    #  work as expected.
+    # @param media_detection_enabled [Boolean] Whether automatic media detection is enabled. When enabled, the filter will
+    #  automatically
+    #  detect consistent background TV/music/radio and switch to more aggressive
+    #  filtering settings.
+    #  Only applies when enabled is true.
+    # @param static_threshold [Float] Static threshold in dB used as fallback when no baseline is established.
+    # @param baseline_offset_db [Float] How far below the rolling baseline to filter audio, in dB.
+    #  Lower values (e.g., -10) are more aggressive, higher values (e.g., -20) are more
+    #  conservative.
+    # @param window_size_ms [Float] Rolling window size in milliseconds for calculating the audio baseline.
+    #  Larger windows adapt more slowly but are more stable.
+    # @param baseline_percentile [Float] Percentile to use for baseline calculation (1-99).
+    #  Higher percentiles (e.g., 85) focus on louder speech, lower percentiles (e.g.,
+    #  50) include quieter speech.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::FourierDenoisingPlan]
+    def initialize(enabled: OMIT, media_detection_enabled: OMIT, static_threshold: OMIT, baseline_offset_db: OMIT,
+                   window_size_ms: OMIT, baseline_percentile: OMIT, additional_properties: nil)
+      @enabled = enabled if enabled != OMIT
+      @media_detection_enabled = media_detection_enabled if media_detection_enabled != OMIT
+      @static_threshold = static_threshold if static_threshold != OMIT
+      @baseline_offset_db = baseline_offset_db if baseline_offset_db != OMIT
+      @window_size_ms = window_size_ms if window_size_ms != OMIT
+      @baseline_percentile = baseline_percentile if baseline_percentile != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "enabled": enabled,
+        "mediaDetectionEnabled": media_detection_enabled,
+        "staticThreshold": static_threshold,
+        "baselineOffsetDb": baseline_offset_db,
+        "windowSizeMs": window_size_ms,
+        "baselinePercentile": baseline_percentile
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of FourierDenoisingPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::FourierDenoisingPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      enabled = parsed_json["enabled"]
+      media_detection_enabled = parsed_json["mediaDetectionEnabled"]
+      static_threshold = parsed_json["staticThreshold"]
+      baseline_offset_db = parsed_json["baselineOffsetDb"]
+      window_size_ms = parsed_json["windowSizeMs"]
+      baseline_percentile = parsed_json["baselinePercentile"]
+      new(
+        enabled: enabled,
+        media_detection_enabled: media_detection_enabled,
+        static_threshold: static_threshold,
+        baseline_offset_db: baseline_offset_db,
+        window_size_ms: window_size_ms,
+        baseline_percentile: baseline_percentile,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FourierDenoisingPlan to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.enabled is not the expected type, validation failed.")
+      obj.media_detection_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.media_detection_enabled is not the expected type, validation failed.")
+      obj.static_threshold&.is_a?(Float) != false || raise("Passed value for field obj.static_threshold is not the expected type, validation failed.")
+      obj.baseline_offset_db&.is_a?(Float) != false || raise("Passed value for field obj.baseline_offset_db is not the expected type, validation failed.")
+      obj.window_size_ms&.is_a?(Float) != false || raise("Passed value for field obj.window_size_ms is not the expected type, validation failed.")
+      obj.baseline_percentile&.is_a?(Float) != false || raise("Passed value for field obj.baseline_percentile is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/function_call.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class FunctionCall
+    # @return [String] This is the arguments to call the function with
+    attr_reader :arguments
+    # @return [String] This is the name of the function to call
+    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 arguments [String] This is the arguments to call the function with
+    # @param name [String] This is the name of the function to call
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::FunctionCall]
+    def initialize(arguments:, name:, additional_properties: nil)
+      @arguments = arguments
+      @name = name
+      @additional_properties = additional_properties
+      @_field_set = { "arguments": arguments, "name": name }
+    end
+
+    # Deserialize a JSON object to an instance of FunctionCall
+    #
+    # @param json_object [String]
+    # @return [Vapi::FunctionCall]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      arguments = parsed_json["arguments"]
+      name = parsed_json["name"]
+      new(
+        arguments: arguments,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FunctionCall 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.arguments.is_a?(String) != false || raise("Passed value for field obj.arguments 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/function_call_assistant_hook_action.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require_relative "function_call_assistant_hook_action_messages_item"
+require_relative "server"
+require_relative "open_ai_function"
+require "ostruct"
+require "json"
+
+module Vapi
+  class FunctionCallAssistantHookAction
+    # @return [Array<Vapi::FunctionCallAssistantHookActionMessagesItem>] These are the messages that will be spoken to the user as the tool is running.
+    #  For some tools, this is auto-filled based on special fields like
+    #  `tool.destinations`. For others like the function tool, these can be custom
+    #  configured.
+    attr_reader :messages
+    # @return [Boolean] This determines if the tool is async.
+    #  If async, the assistant will move forward without waiting for your server to
+    #  respond. This is useful if you just want to trigger something on your server.
+    #  If sync, the assistant will wait for your server to respond. This is useful if
+    #  want assistant to respond with the result from your server.
+    #  Defaults to synchronous (`false`).
+    attr_reader :async
+    # @return [Vapi::Server]
+    #  This is the server where a `tool-calls` webhook will be sent.
+    #  Notes:
+    #  - Webhook is sent to this server when a tool call is made.
+    #  - Webhook contains the call, assistant, and phone number objects.
+    #  - Webhook contains the variables set on the assistant.
+    #  - Webhook is sent to the first available URL in this order:
+    #  {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}},
+    #  {{org.server.url}}.
+    #  - Webhook expects a response with tool call result.
+    attr_reader :server
+    # @return [Vapi::OpenAiFunction] This is the function definition of the tool.
+    #  For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on
+    #  tool-specific fields like `tool.destinations`. But, even in those cases, you can
+    #  provide a custom function definition for advanced use cases.
+    #  An example of an advanced use case is if you want to customize the message
+    #  that's spoken for `endCall` tool. You can specify a function where it returns an
+    #  argument "reason". Then, in `messages` array, you can have many
+    #  "request-complete" messages. One of these messages will be triggered if the
+    #  `messages[].conditions` matches the "reason" argument.
+    attr_reader :function
+    # @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<Vapi::FunctionCallAssistantHookActionMessagesItem>] These are the messages that will be spoken to the user as the tool is running.
+    #  For some tools, this is auto-filled based on special fields like
+    #  `tool.destinations`. For others like the function tool, these can be custom
+    #  configured.
+    # @param async [Boolean] This determines if the tool is async.
+    #  If async, the assistant will move forward without waiting for your server to
+    #  respond. This is useful if you just want to trigger something on your server.
+    #  If sync, the assistant will wait for your server to respond. This is useful if
+    #  want assistant to respond with the result from your server.
+    #  Defaults to synchronous (`false`).
+    # @param server [Vapi::Server]
+    #  This is the server where a `tool-calls` webhook will be sent.
+    #  Notes:
+    #  - Webhook is sent to this server when a tool call is made.
+    #  - Webhook contains the call, assistant, and phone number objects.
+    #  - Webhook contains the variables set on the assistant.
+    #  - Webhook is sent to the first available URL in this order:
+    #  {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}},
+    #  {{org.server.url}}.
+    #  - Webhook expects a response with tool call result.
+    # @param function [Vapi::OpenAiFunction] This is the function definition of the tool.
+    #  For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on
+    #  tool-specific fields like `tool.destinations`. But, even in those cases, you can
+    #  provide a custom function definition for advanced use cases.
+    #  An example of an advanced use case is if you want to customize the message
+    #  that's spoken for `endCall` tool. You can specify a function where it returns an
+    #  argument "reason". Then, in `messages` array, you can have many
+    #  "request-complete" messages. One of these messages will be triggered if the
+    #  `messages[].conditions` matches the "reason" argument.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::FunctionCallAssistantHookAction]
+    def initialize(messages: OMIT, async: OMIT, server: OMIT, function: OMIT, additional_properties: nil)
+      @messages = messages if messages != OMIT
+      @async = async if async != OMIT
+      @server = server if server != OMIT
+      @function = function if function != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "messages": messages, "async": async, "server": server, "function": function }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of FunctionCallAssistantHookAction
+    #
+    # @param json_object [String]
+    # @return [Vapi::FunctionCallAssistantHookAction]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      messages = parsed_json["messages"]&.map do |item|
+        item = item.to_json
+        Vapi::FunctionCallAssistantHookActionMessagesItem.from_json(json_object: item)
+      end
+      async = parsed_json["async"]
+      if parsed_json["server"].nil?
+        server = nil
+      else
+        server = parsed_json["server"].to_json
+        server = Vapi::Server.from_json(json_object: server)
+      end
+      if parsed_json["function"].nil?
+        function = nil
+      else
+        function = parsed_json["function"].to_json
+        function = Vapi::OpenAiFunction.from_json(json_object: function)
+      end
+      new(
+        messages: messages,
+        async: async,
+        server: server,
+        function: function,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FunctionCallAssistantHookAction 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.async&.is_a?(Boolean) != false || raise("Passed value for field obj.async is not the expected type, validation failed.")
+      obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
+      obj.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)
+    end
+  end
+end