vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/tool_call_result_message_item.rb

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

data/lib/vapi_server_sdk/types/tool_message_complete.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require_relative "tool_message_complete_role"
+require_relative "condition"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ToolMessageComplete
+    # @return [Vapi::ToolMessageCompleteRole] This is optional and defaults to "assistant".
+    #  When role=assistant, `content` is said out loud.
+    #  When role=system, `content` is passed to the model in a system message. Example:
+    #  system: default one
+    #  assistant:
+    #  user:
+    #  assistant:
+    #  user:
+    #  assistant:
+    #  user:
+    #  assistant: tool called
+    #  tool: your server response
+    #  <--- system prompt as hint
+    #  ---> model generates response which is spoken
+    #  This is useful when you want to provide a hint to the model about what to say
+    #  next.
+    attr_reader :role
+    # @return [Boolean] This is an optional boolean that if true, the call will end after the message is
+    #  spoken. Default is false.
+    #  This is ignored if `role` is set to `system`.
+    #  @default false
+    attr_reader :end_call_after_spoken_enabled
+    # @return [String] This is the content that the assistant says when this message is triggered.
+    attr_reader :content
+    # @return [Array<Vapi::Condition>] This is an optional array of conditions that the tool call arguments must meet
+    #  in order for this message to be triggered.
+    attr_reader :conditions
+    # @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 role [Vapi::ToolMessageCompleteRole] This is optional and defaults to "assistant".
+    #  When role=assistant, `content` is said out loud.
+    #  When role=system, `content` is passed to the model in a system message. Example:
+    #  system: default one
+    #  assistant:
+    #  user:
+    #  assistant:
+    #  user:
+    #  assistant:
+    #  user:
+    #  assistant: tool called
+    #  tool: your server response
+    #  <--- system prompt as hint
+    #  ---> model generates response which is spoken
+    #  This is useful when you want to provide a hint to the model about what to say
+    #  next.
+    # @param end_call_after_spoken_enabled [Boolean] This is an optional boolean that if true, the call will end after the message is
+    #  spoken. Default is false.
+    #  This is ignored if `role` is set to `system`.
+    #  @default false
+    # @param content [String] This is the content that the assistant says when this message is triggered.
+    # @param conditions [Array<Vapi::Condition>] This is an optional array of conditions that the tool call arguments must meet
+    #  in order for this message to be triggered.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ToolMessageComplete]
+    def initialize(content:, role: OMIT, end_call_after_spoken_enabled: OMIT, conditions: OMIT,
+                   additional_properties: nil)
+      @role = role if role != OMIT
+      @end_call_after_spoken_enabled = end_call_after_spoken_enabled if end_call_after_spoken_enabled != OMIT
+      @content = content
+      @conditions = conditions if conditions != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "role": role,
+        "endCallAfterSpokenEnabled": end_call_after_spoken_enabled,
+        "content": content,
+        "conditions": conditions
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ToolMessageComplete
+    #
+    # @param json_object [String]
+    # @return [Vapi::ToolMessageComplete]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      role = parsed_json["role"]
+      end_call_after_spoken_enabled = parsed_json["endCallAfterSpokenEnabled"]
+      content = parsed_json["content"]
+      conditions = parsed_json["conditions"]&.map do |item|
+        item = item.to_json
+        Vapi::Condition.from_json(json_object: item)
+      end
+      new(
+        role: role,
+        end_call_after_spoken_enabled: end_call_after_spoken_enabled,
+        content: content,
+        conditions: conditions,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ToolMessageComplete 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.role&.is_a?(Vapi::ToolMessageCompleteRole) != false || raise("Passed value for field obj.role is not the expected type, validation failed.")
+      obj.end_call_after_spoken_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.end_call_after_spoken_enabled is not the expected type, validation failed.")
+      obj.content.is_a?(String) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
+      obj.conditions&.is_a?(Array) != false || raise("Passed value for field obj.conditions is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/tool_message_complete_role.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is optional and defaults to "assistant".
+  #  When role=assistant, `content` is said out loud.
+  #  When role=system, `content` is passed to the model in a system message. Example:
+  #  system: default one
+  #  assistant:
+  #  user:
+  #  assistant:
+  #  user:
+  #  assistant:
+  #  user:
+  #  assistant: tool called
+  #  tool: your server response
+  #  <--- system prompt as hint
+  #  ---> model generates response which is spoken
+  #  This is useful when you want to provide a hint to the model about what to say
+  #  next.
+  class ToolMessageCompleteRole
+    ASSISTANT = "assistant"
+    SYSTEM = "system"
+  end
+end

data/lib/vapi_server_sdk/types/tool_message_delayed.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative "condition"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ToolMessageDelayed
+    # @return [Float] The number of milliseconds to wait for the server response before saying this
+    #  message.
+    attr_reader :timing_milliseconds
+    # @return [String] This is the content that the assistant says when this message is triggered.
+    attr_reader :content
+    # @return [Array<Vapi::Condition>] This is an optional array of conditions that the tool call arguments must meet
+    #  in order for this message to be triggered.
+    attr_reader :conditions
+    # @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 timing_milliseconds [Float] The number of milliseconds to wait for the server response before saying this
+    #  message.
+    # @param content [String] This is the content that the assistant says when this message is triggered.
+    # @param conditions [Array<Vapi::Condition>] This is an optional array of conditions that the tool call arguments must meet
+    #  in order for this message to be triggered.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ToolMessageDelayed]
+    def initialize(content:, timing_milliseconds: OMIT, conditions: OMIT, additional_properties: nil)
+      @timing_milliseconds = timing_milliseconds if timing_milliseconds != OMIT
+      @content = content
+      @conditions = conditions if conditions != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "timingMilliseconds": timing_milliseconds,
+        "content": content,
+        "conditions": conditions
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ToolMessageDelayed
+    #
+    # @param json_object [String]
+    # @return [Vapi::ToolMessageDelayed]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      timing_milliseconds = parsed_json["timingMilliseconds"]
+      content = parsed_json["content"]
+      conditions = parsed_json["conditions"]&.map do |item|
+        item = item.to_json
+        Vapi::Condition.from_json(json_object: item)
+      end
+      new(
+        timing_milliseconds: timing_milliseconds,
+        content: content,
+        conditions: conditions,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ToolMessageDelayed 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.timing_milliseconds&.is_a?(Float) != false || raise("Passed value for field obj.timing_milliseconds is not the expected type, validation failed.")
+      obj.content.is_a?(String) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
+      obj.conditions&.is_a?(Array) != false || raise("Passed value for field obj.conditions is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/tool_message_failed.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative "condition"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ToolMessageFailed
+    # @return [Boolean] This is an optional boolean that if true, the call will end after the message is
+    #  spoken. Default is false.
+    #  @default false
+    attr_reader :end_call_after_spoken_enabled
+    # @return [String] This is the content that the assistant says when this message is triggered.
+    attr_reader :content
+    # @return [Array<Vapi::Condition>] This is an optional array of conditions that the tool call arguments must meet
+    #  in order for this message to be triggered.
+    attr_reader :conditions
+    # @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 end_call_after_spoken_enabled [Boolean] This is an optional boolean that if true, the call will end after the message is
+    #  spoken. Default is false.
+    #  @default false
+    # @param content [String] This is the content that the assistant says when this message is triggered.
+    # @param conditions [Array<Vapi::Condition>] This is an optional array of conditions that the tool call arguments must meet
+    #  in order for this message to be triggered.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ToolMessageFailed]
+    def initialize(content:, end_call_after_spoken_enabled: OMIT, conditions: OMIT, additional_properties: nil)
+      @end_call_after_spoken_enabled = end_call_after_spoken_enabled if end_call_after_spoken_enabled != OMIT
+      @content = content
+      @conditions = conditions if conditions != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "endCallAfterSpokenEnabled": end_call_after_spoken_enabled,
+        "content": content,
+        "conditions": conditions
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ToolMessageFailed
+    #
+    # @param json_object [String]
+    # @return [Vapi::ToolMessageFailed]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      end_call_after_spoken_enabled = parsed_json["endCallAfterSpokenEnabled"]
+      content = parsed_json["content"]
+      conditions = parsed_json["conditions"]&.map do |item|
+        item = item.to_json
+        Vapi::Condition.from_json(json_object: item)
+      end
+      new(
+        end_call_after_spoken_enabled: end_call_after_spoken_enabled,
+        content: content,
+        conditions: conditions,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ToolMessageFailed 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.end_call_after_spoken_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.end_call_after_spoken_enabled is not the expected type, validation failed.")
+      obj.content.is_a?(String) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
+      obj.conditions&.is_a?(Array) != false || raise("Passed value for field obj.conditions is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/tool_message_start.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "condition"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ToolMessageStart
+    # @return [String] This is the content that the assistant says when this message is triggered.
+    attr_reader :content
+    # @return [Array<Vapi::Condition>] This is an optional array of conditions that the tool call arguments must meet
+    #  in order for this message to be triggered.
+    attr_reader :conditions
+    # @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 content [String] This is the content that the assistant says when this message is triggered.
+    # @param conditions [Array<Vapi::Condition>] This is an optional array of conditions that the tool call arguments must meet
+    #  in order for this message to be triggered.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ToolMessageStart]
+    def initialize(content:, conditions: OMIT, additional_properties: nil)
+      @content = content
+      @conditions = conditions if conditions != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "content": content, "conditions": conditions }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ToolMessageStart
+    #
+    # @param json_object [String]
+    # @return [Vapi::ToolMessageStart]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      content = parsed_json["content"]
+      conditions = parsed_json["conditions"]&.map do |item|
+        item = item.to_json
+        Vapi::Condition.from_json(json_object: item)
+      end
+      new(
+        content: content,
+        conditions: conditions,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ToolMessageStart 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.content.is_a?(String) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
+      obj.conditions&.is_a?(Array) != false || raise("Passed value for field obj.conditions is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/tool_template_metadata.rb

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

data/lib/vapi_server_sdk/types/tool_template_setup.rb

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