vapi_server_sdk 0.5.0 → 0.9.1

data/lib/vapi_server_sdk/types/api_request_tool.rb

@@ -0,0 +1,584 @@
+# frozen_string_literal: true
+
+require_relative "api_request_tool_messages_item"
+require_relative "api_request_tool_method"
+require "date"
+require_relative "open_ai_function"
+require_relative "json_schema"
+require_relative "backoff_plan"
+require_relative "variable_extraction_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ApiRequestTool
+    # @return [Array<Vapi::ApiRequestToolMessagesItem>] 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 [Vapi::ApiRequestToolMethod]
+    attr_reader :method
+    # @return [Float] This is the timeout in seconds for the request. Defaults to 20 seconds.
+    #  @default 20
+    attr_reader :timeout_seconds
+    # @return [String] This is the unique identifier for the tool.
+    attr_reader :id
+    # @return [String] This is the unique identifier for the organization that this tool belongs to.
+    attr_reader :org_id
+    # @return [DateTime] This is the ISO 8601 date-time string of when the tool was created.
+    attr_reader :created_at
+    # @return [DateTime] This is the ISO 8601 date-time string of when the tool was last updated.
+    attr_reader :updated_at
+    # @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 [String] This is the name of the tool. This will be passed to the model.
+    #  Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length
+    #  of 40.
+    attr_reader :name
+    # @return [String] This is the description of the tool. This will be passed to the model.
+    attr_reader :description
+    # @return [String] This is where the request will be sent.
+    attr_reader :url
+    # @return [Vapi::JsonSchema] This is the body of the request.
+    attr_reader :body
+    # @return [Vapi::JsonSchema] These are the headers to send in the request.
+    attr_reader :headers
+    # @return [Vapi::BackoffPlan] This is the backoff plan if the request fails. Defaults to undefined (the
+    #  request will not be retried).
+    #  @default undefined (the request will not be retried)
+    attr_reader :backoff_plan
+    # @return [Vapi::VariableExtractionPlan] This is the plan to extract variables from the tool's response. These will be
+    #  accessible during the call and stored in `call.artifact.variableValues` after
+    #  the call.
+    #  Usage:
+    #  1. Use `aliases` to extract variables from the tool's response body. (Most
+    #  common case)
+    #  ```json
+    #  {
+    #  "aliases": [
+    #  {
+    #  "key": "customerName",
+    #  "value": "{{customer.name}}"
+    #  },
+    #  {
+    #  "key": "customerAge",
+    #  "value": "{{customer.age}}"
+    #  }
+    #  ]
+    #  }
+    #  ```
+    #  The tool response body is made available to the liquid template.
+    #  2. Use `aliases` to extract variables from the tool's response body if the
+    #  response is an array.
+    #  ```json
+    #  {
+    #  "aliases": [
+    #  {
+    #  "key": "customerName",
+    #  "value": "{{$[0].name}}"
+    #  },
+    #  {
+    #  "key": "customerAge",
+    #  "value": "{{$[0].age}}"
+    #  }
+    #  ]
+    #  }
+    #  ```
+    #  $ is a shorthand for the tool's response body. `$[0]` is the first item in the
+    #  array. `$[n]` is the nth item in the array. Note, $ is available regardless of
+    #  the response body type (both object and array).
+    #  3. Use `aliases` to extract variables from the tool's response headers.
+    #  ```json
+    #  {
+    #  "aliases": [
+    #  {
+    #  "key": "customerName",
+    #  "value": "{{tool.response.headers.customer-name}}"
+    #  },
+    #  {
+    #  "key": "customerAge",
+    #  "value": "{{tool.response.headers.customer-age}}"
+    #  }
+    #  ]
+    #  }
+    #  ```
+    #  `tool.response` is made available to the liquid template. Particularly, both
+    #  `tool.response.headers` and `tool.response.body` are available. Note,
+    #  `tool.response` is available regardless of the response body type (both object
+    #  and array).
+    #  4. Use `schema` to extract a large portion of the tool's response body.
+    #  4.1. If you hit example.com and it returns `{"name": "John", "age": 30}`, then
+    #  you can specify the schema as:
+    #  ```json
+    #  {
+    #  "schema": {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "string"
+    #  },
+    #  "age": {
+    #  "type": "number"
+    #  }
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  4.2. If you hit example.com and it returns `{"name": {"first": "John", "last":
+    #  "Doe"}}`, then you can specify the schema as:
+    #  ```json
+    #  {
+    #  "schema": {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "object",
+    #  "properties": {
+    #  "first": {
+    #  "type": "string"
+    #  },
+    #  "last": {
+    #  "type": "string"
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  These will be extracted as `{{ name }}` and `{{ age }}` respectively. To
+    #  emphasize, object properties are extracted as direct global variables.
+    #  4.3. If you hit example.com and it returns `{"name": {"first": "John", "last":
+    #  "Doe"}}`, then you can specify the schema as:
+    #  ```json
+    #  {
+    #  "schema": {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "object",
+    #  "properties": {
+    #  "first": {
+    #  "type": "string"
+    #  },
+    #  "last": {
+    #  "type": "string"
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  These will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{
+    #  name.last }}` will be accessible.
+    #  4.4. If you hit example.com and it returns `["94123", "94124"]`, then you can
+    #  specify the schema as:
+    #  ```json
+    #  {
+    #  "schema": {
+    #  "type": "array",
+    #  "title": "zipCodes",
+    #  "items": {
+    #  "type": "string"
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  This will be extracted as `{{ zipCodes }}`. To access the array items, you can
+    #  use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.
+    #  4.5. If you hit example.com and it returns `[{"name": "John", "age": 30,
+    #  "zipCodes": ["94123", "94124"]}, {"name": "Jane", "age": 25, "zipCodes":
+    #  ["94125", "94126"]}]`, then you can specify the schema as:
+    #  ```json
+    #  {
+    #  "schema": {
+    #  "type": "array",
+    #  "title": "people",
+    #  "items": {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "string"
+    #  },
+    #  "age": {
+    #  "type": "number"
+    #  },
+    #  "zipCodes": {
+    #  "type": "array",
+    #  "items": {
+    #  "type": "string"
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  This will be extracted as `{{ people }}`. To access the array items, you can use
+    #  `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{
+    #  people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.
+    #  Note: Both `aliases` and `schema` can be used together.
+    attr_reader :variable_extraction_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 messages [Array<Vapi::ApiRequestToolMessagesItem>] 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 method [Vapi::ApiRequestToolMethod]
+    # @param timeout_seconds [Float] This is the timeout in seconds for the request. Defaults to 20 seconds.
+    #  @default 20
+    # @param id [String] This is the unique identifier for the tool.
+    # @param org_id [String] This is the unique identifier for the organization that this tool belongs to.
+    # @param created_at [DateTime] This is the ISO 8601 date-time string of when the tool was created.
+    # @param updated_at [DateTime] This is the ISO 8601 date-time string of when the tool was last updated.
+    # @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 name [String] This is the name of the tool. This will be passed to the model.
+    #  Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length
+    #  of 40.
+    # @param description [String] This is the description of the tool. This will be passed to the model.
+    # @param url [String] This is where the request will be sent.
+    # @param body [Vapi::JsonSchema] This is the body of the request.
+    # @param headers [Vapi::JsonSchema] These are the headers to send in the request.
+    # @param backoff_plan [Vapi::BackoffPlan] This is the backoff plan if the request fails. Defaults to undefined (the
+    #  request will not be retried).
+    #  @default undefined (the request will not be retried)
+    # @param variable_extraction_plan [Vapi::VariableExtractionPlan] This is the plan to extract variables from the tool's response. These will be
+    #  accessible during the call and stored in `call.artifact.variableValues` after
+    #  the call.
+    #  Usage:
+    #  1. Use `aliases` to extract variables from the tool's response body. (Most
+    #  common case)
+    #  ```json
+    #  {
+    #  "aliases": [
+    #  {
+    #  "key": "customerName",
+    #  "value": "{{customer.name}}"
+    #  },
+    #  {
+    #  "key": "customerAge",
+    #  "value": "{{customer.age}}"
+    #  }
+    #  ]
+    #  }
+    #  ```
+    #  The tool response body is made available to the liquid template.
+    #  2. Use `aliases` to extract variables from the tool's response body if the
+    #  response is an array.
+    #  ```json
+    #  {
+    #  "aliases": [
+    #  {
+    #  "key": "customerName",
+    #  "value": "{{$[0].name}}"
+    #  },
+    #  {
+    #  "key": "customerAge",
+    #  "value": "{{$[0].age}}"
+    #  }
+    #  ]
+    #  }
+    #  ```
+    #  $ is a shorthand for the tool's response body. `$[0]` is the first item in the
+    #  array. `$[n]` is the nth item in the array. Note, $ is available regardless of
+    #  the response body type (both object and array).
+    #  3. Use `aliases` to extract variables from the tool's response headers.
+    #  ```json
+    #  {
+    #  "aliases": [
+    #  {
+    #  "key": "customerName",
+    #  "value": "{{tool.response.headers.customer-name}}"
+    #  },
+    #  {
+    #  "key": "customerAge",
+    #  "value": "{{tool.response.headers.customer-age}}"
+    #  }
+    #  ]
+    #  }
+    #  ```
+    #  `tool.response` is made available to the liquid template. Particularly, both
+    #  `tool.response.headers` and `tool.response.body` are available. Note,
+    #  `tool.response` is available regardless of the response body type (both object
+    #  and array).
+    #  4. Use `schema` to extract a large portion of the tool's response body.
+    #  4.1. If you hit example.com and it returns `{"name": "John", "age": 30}`, then
+    #  you can specify the schema as:
+    #  ```json
+    #  {
+    #  "schema": {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "string"
+    #  },
+    #  "age": {
+    #  "type": "number"
+    #  }
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  4.2. If you hit example.com and it returns `{"name": {"first": "John", "last":
+    #  "Doe"}}`, then you can specify the schema as:
+    #  ```json
+    #  {
+    #  "schema": {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "object",
+    #  "properties": {
+    #  "first": {
+    #  "type": "string"
+    #  },
+    #  "last": {
+    #  "type": "string"
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  These will be extracted as `{{ name }}` and `{{ age }}` respectively. To
+    #  emphasize, object properties are extracted as direct global variables.
+    #  4.3. If you hit example.com and it returns `{"name": {"first": "John", "last":
+    #  "Doe"}}`, then you can specify the schema as:
+    #  ```json
+    #  {
+    #  "schema": {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "object",
+    #  "properties": {
+    #  "first": {
+    #  "type": "string"
+    #  },
+    #  "last": {
+    #  "type": "string"
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  These will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{
+    #  name.last }}` will be accessible.
+    #  4.4. If you hit example.com and it returns `["94123", "94124"]`, then you can
+    #  specify the schema as:
+    #  ```json
+    #  {
+    #  "schema": {
+    #  "type": "array",
+    #  "title": "zipCodes",
+    #  "items": {
+    #  "type": "string"
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  This will be extracted as `{{ zipCodes }}`. To access the array items, you can
+    #  use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.
+    #  4.5. If you hit example.com and it returns `[{"name": "John", "age": 30,
+    #  "zipCodes": ["94123", "94124"]}, {"name": "Jane", "age": 25, "zipCodes":
+    #  ["94125", "94126"]}]`, then you can specify the schema as:
+    #  ```json
+    #  {
+    #  "schema": {
+    #  "type": "array",
+    #  "title": "people",
+    #  "items": {
+    #  "type": "object",
+    #  "properties": {
+    #  "name": {
+    #  "type": "string"
+    #  },
+    #  "age": {
+    #  "type": "number"
+    #  },
+    #  "zipCodes": {
+    #  "type": "array",
+    #  "items": {
+    #  "type": "string"
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  }
+    #  ```
+    #  This will be extracted as `{{ people }}`. To access the array items, you can use
+    #  `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{
+    #  people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.
+    #  Note: Both `aliases` and `schema` can be used together.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ApiRequestTool]
+    def initialize(method:, id:, org_id:, created_at:, updated_at:, url:, messages: OMIT, timeout_seconds: OMIT,
+                   function: OMIT, name: OMIT, description: OMIT, body: OMIT, headers: OMIT, backoff_plan: OMIT, variable_extraction_plan: OMIT, additional_properties: nil)
+      @messages = messages if messages != OMIT
+      @method = method
+      @timeout_seconds = timeout_seconds if timeout_seconds != OMIT
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @function = function if function != OMIT
+      @name = name if name != OMIT
+      @description = description if description != OMIT
+      @url = url
+      @body = body if body != OMIT
+      @headers = headers if headers != OMIT
+      @backoff_plan = backoff_plan if backoff_plan != OMIT
+      @variable_extraction_plan = variable_extraction_plan if variable_extraction_plan != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "messages": messages,
+        "method": method,
+        "timeoutSeconds": timeout_seconds,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at,
+        "function": function,
+        "name": name,
+        "description": description,
+        "url": url,
+        "body": body,
+        "headers": headers,
+        "backoffPlan": backoff_plan,
+        "variableExtractionPlan": variable_extraction_plan
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ApiRequestTool
+    #
+    # @param json_object [String]
+    # @return [Vapi::ApiRequestTool]
+    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::ApiRequestToolMessagesItem.from_json(json_object: item)
+      end
+      method = parsed_json["method"]
+      timeout_seconds = parsed_json["timeoutSeconds"]
+      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?)
+      if parsed_json["function"].nil?
+        function = nil
+      else
+        function = parsed_json["function"].to_json
+        function = Vapi::OpenAiFunction.from_json(json_object: function)
+      end
+      name = parsed_json["name"]
+      description = parsed_json["description"]
+      url = parsed_json["url"]
+      if parsed_json["body"].nil?
+        body = nil
+      else
+        body = parsed_json["body"].to_json
+        body = Vapi::JsonSchema.from_json(json_object: body)
+      end
+      if parsed_json["headers"].nil?
+        headers = nil
+      else
+        headers = parsed_json["headers"].to_json
+        headers = Vapi::JsonSchema.from_json(json_object: headers)
+      end
+      if parsed_json["backoffPlan"].nil?
+        backoff_plan = nil
+      else
+        backoff_plan = parsed_json["backoffPlan"].to_json
+        backoff_plan = Vapi::BackoffPlan.from_json(json_object: backoff_plan)
+      end
+      if parsed_json["variableExtractionPlan"].nil?
+        variable_extraction_plan = nil
+      else
+        variable_extraction_plan = parsed_json["variableExtractionPlan"].to_json
+        variable_extraction_plan = Vapi::VariableExtractionPlan.from_json(json_object: variable_extraction_plan)
+      end
+      new(
+        messages: messages,
+        method: method,
+        timeout_seconds: timeout_seconds,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        function: function,
+        name: name,
+        description: description,
+        url: url,
+        body: body,
+        headers: headers,
+        backoff_plan: backoff_plan,
+        variable_extraction_plan: variable_extraction_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ApiRequestTool 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.method.is_a?(Vapi::ApiRequestToolMethod) != false || raise("Passed value for field obj.method 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.")
+      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.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)
+      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.description&.is_a?(String) != false || raise("Passed value for field obj.description 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.body.nil? || Vapi::JsonSchema.validate_raw(obj: obj.body)
+      obj.headers.nil? || Vapi::JsonSchema.validate_raw(obj: obj.headers)
+      obj.backoff_plan.nil? || Vapi::BackoffPlan.validate_raw(obj: obj.backoff_plan)
+      obj.variable_extraction_plan.nil? || Vapi::VariableExtractionPlan.validate_raw(obj: obj.variable_extraction_plan)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/api_request_tool_messages_item.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "tool_message_start"
+require_relative "tool_message_complete"
+require_relative "tool_message_failed"
+require_relative "tool_message_delayed"
+
+module Vapi
+  class ApiRequestToolMessagesItem
+    # @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::ApiRequestToolMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of ApiRequestToolMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::ApiRequestToolMessagesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "request-start"
+                 Vapi::ToolMessageStart.from_json(json_object: json_object)
+               when "request-complete"
+                 Vapi::ToolMessageComplete.from_json(json_object: json_object)
+               when "request-failed"
+                 Vapi::ToolMessageFailed.from_json(json_object: json_object)
+               when "request-response-delayed"
+                 Vapi::ToolMessageDelayed.from_json(json_object: json_object)
+               else
+                 Vapi::ToolMessageStart.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 "request-start"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-complete"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-failed"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-response-delayed"
+        { **@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 "request-start"
+        Vapi::ToolMessageStart.validate_raw(obj: obj)
+      when "request-complete"
+        Vapi::ToolMessageComplete.validate_raw(obj: obj)
+      when "request-failed"
+        Vapi::ToolMessageFailed.validate_raw(obj: obj)
+      when "request-response-delayed"
+        Vapi::ToolMessageDelayed.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::ToolMessageStart]
+    # @return [Vapi::ApiRequestToolMessagesItem]
+    def self.request_start(member:)
+      new(member: member, discriminant: "request-start")
+    end
+
+    # @param member [Vapi::ToolMessageComplete]
+    # @return [Vapi::ApiRequestToolMessagesItem]
+    def self.request_complete(member:)
+      new(member: member, discriminant: "request-complete")
+    end
+
+    # @param member [Vapi::ToolMessageFailed]
+    # @return [Vapi::ApiRequestToolMessagesItem]
+    def self.request_failed(member:)
+      new(member: member, discriminant: "request-failed")
+    end
+
+    # @param member [Vapi::ToolMessageDelayed]
+    # @return [Vapi::ApiRequestToolMessagesItem]
+    def self.request_response_delayed(member:)
+      new(member: member, discriminant: "request-response-delayed")
+    end
+  end
+end