RubyGems - vapi_server_sdk - Versions diffs - 0.3.0 → 0.4.0 - Mend

vapi_server_sdk 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (64) hide show

data/lib/vapi_server_sdk/types/gather.rb ADDED Viewed

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

@@ -22,8 +22,6 @@ module Vapi
     #  `tool.destinations`. For others like the function tool, these can be custom
     #  configured.
     attr_reader :messages
-    # @return [String] The type of tool. "ghl" for GHL tool.
-    attr_reader :type
     # @return [Vapi::ToolCall]
     attr_reader :tool_call
     # @return [Vapi::GhlToolMetadata]
@@ -63,7 +61,6 @@ module Vapi
     #  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 type [String] The type of tool. "ghl" for GHL tool.
     # @param tool_call [Vapi::ToolCall]
     # @param metadata [Vapi::GhlToolMetadata]
     # @param function [Vapi::OpenAiFunction] This is the function definition of the tool.
@@ -83,11 +80,10 @@ module Vapi
     #  phoneNumber.serverUrl, then org.serverUrl.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::GhlToolWithToolCall]
-    def initialize(type:, tool_call:, metadata:, async: OMIT, messages: OMIT, function: OMIT, server: OMIT,
+    def initialize(tool_call:, metadata:, async: OMIT, messages: OMIT, function: OMIT, server: OMIT,
                    additional_properties: nil)
       @async = async if async != OMIT
       @messages = messages if messages != OMIT
-      @type = type
       @tool_call = tool_call
       @metadata = metadata
       @function = function if function != OMIT
@@ -96,7 +92,6 @@ module Vapi
       @_field_set = {
         "async": async,
         "messages": messages,
-        "type": type,
         "toolCall": tool_call,
         "metadata": metadata,
         "function": function,
@@ -118,7 +113,6 @@ module Vapi
         item = item.to_json
         Vapi::GhlToolWithToolCallMessagesItem.from_json(json_object: item)
       end
-      type = parsed_json["type"]
       if parsed_json["toolCall"].nil?
         tool_call = nil
       else
@@ -146,7 +140,6 @@ module Vapi
       new(
         async: async,
         messages: messages,
-        type: type,
         tool_call: tool_call,
         metadata: metadata,
         function: function,
@@ -171,7 +164,6 @@ module Vapi
     def self.validate_raw(obj:)
       obj.async&.is_a?(Boolean) != false || raise("Passed value for field obj.async is not the expected type, validation failed.")
       obj.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
-      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       Vapi::ToolCall.validate_raw(obj: obj.tool_call)
       Vapi::GhlToolMetadata.validate_raw(obj: obj.metadata)
       obj.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)

data/lib/vapi_server_sdk/types/json_schema.rb CHANGED Viewed

@@ -31,6 +31,9 @@ module Vapi
     # @return [Array<String>] This is a list of properties that are required.
     #  This only makes sense if the type is "object".
     attr_reader :required
+    # @return [Array<String>] This array specifies the allowed values that can be used to restrict the output
+    #  of the model.
+    attr_reader :enum
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -59,21 +62,26 @@ module Vapi
     # @param description [String] This is the description to help the model understand what it needs to output.
     # @param required [Array<String>] This is a list of properties that are required.
     #  This only makes sense if the type is "object".
+    # @param enum [Array<String>] This array specifies the allowed values that can be used to restrict the output
+    #  of the model.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::JsonSchema]
-    def initialize(type:, items: OMIT, properties: OMIT, description: OMIT, required: OMIT, additional_properties: nil)
+    def initialize(type:, items: OMIT, properties: OMIT, description: OMIT, required: OMIT, enum: OMIT,
+                   additional_properties: nil)
       @type = type
       @items = items if items != OMIT
       @properties = properties if properties != OMIT
       @description = description if description != OMIT
       @required = required if required != OMIT
+      @enum = enum if enum != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "type": type,
         "items": items,
         "properties": properties,
         "description": description,
-        "required": required
+        "required": required,
+        "enum": enum
       }.reject do |_k, v|
         v == OMIT
       end
@@ -91,12 +99,14 @@ module Vapi
       properties = parsed_json["properties"]
       description = parsed_json["description"]
       required = parsed_json["required"]
+      enum = parsed_json["enum"]
       new(
         type: type,
         items: items,
         properties: properties,
         description: description,
         required: required,
+        enum: enum,
         additional_properties: struct
       )
     end
@@ -120,6 +130,7 @@ module Vapi
       obj.properties&.is_a?(Hash) != false || raise("Passed value for field obj.properties 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.required&.is_a?(Array) != false || raise("Passed value for field obj.required is not the expected type, validation failed.")
+      obj.enum&.is_a?(Array) != false || raise("Passed value for field obj.enum is not the expected type, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/log.rb CHANGED Viewed

@@ -91,22 +91,22 @@ module Vapi
     # @param call_id [String] This is the ID of the call.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::Log]
-    def initialize(time:, org_id:, type:, request_duration_seconds:, request_started_at:, request_finished_at:,
-                   request_body:, request_http_method:, request_url:, request_path:, response_http_code:, webhook_type: OMIT, resource: OMIT, request_query: OMIT, request_ip_address: OMIT, request_origin: OMIT, response_body: OMIT, request_headers: OMIT, error: OMIT, assistant_id: OMIT, phone_number_id: OMIT, customer_id: OMIT, squad_id: OMIT, call_id: OMIT, additional_properties: nil)
+    def initialize(time:, org_id:, type:, webhook_type: OMIT, resource: OMIT, request_duration_seconds: OMIT,
+                   request_started_at: OMIT, request_finished_at: OMIT, request_body: OMIT, request_http_method: OMIT, request_url: OMIT, request_path: OMIT, request_query: OMIT, response_http_code: OMIT, request_ip_address: OMIT, request_origin: OMIT, response_body: OMIT, request_headers: OMIT, error: OMIT, assistant_id: OMIT, phone_number_id: OMIT, customer_id: OMIT, squad_id: OMIT, call_id: OMIT, additional_properties: nil)
       @time = time
       @org_id = org_id
       @type = type
       @webhook_type = webhook_type if webhook_type != OMIT
       @resource = resource if resource != OMIT
-      @request_duration_seconds = request_duration_seconds
-      @request_started_at = request_started_at
-      @request_finished_at = request_finished_at
-      @request_body = request_body
-      @request_http_method = request_http_method
-      @request_url = request_url
-      @request_path = request_path
+      @request_duration_seconds = request_duration_seconds if request_duration_seconds != OMIT
+      @request_started_at = request_started_at if request_started_at != OMIT
+      @request_finished_at = request_finished_at if request_finished_at != OMIT
+      @request_body = request_body if request_body != OMIT
+      @request_http_method = request_http_method if request_http_method != OMIT
+      @request_url = request_url if request_url != OMIT
+      @request_path = request_path if request_path != OMIT
       @request_query = request_query if request_query != OMIT
-      @response_http_code = response_http_code
+      @response_http_code = response_http_code if response_http_code != OMIT
       @request_ip_address = request_ip_address if request_ip_address != OMIT
       @request_origin = request_origin if request_origin != OMIT
       @response_body = response_body if response_body != OMIT
@@ -232,15 +232,15 @@ module Vapi
       obj.type.is_a?(Vapi::LogType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       obj.webhook_type&.is_a?(String) != false || raise("Passed value for field obj.webhook_type is not the expected type, validation failed.")
       obj.resource&.is_a?(Vapi::LogResource) != false || raise("Passed value for field obj.resource is not the expected type, validation failed.")
-      obj.request_duration_seconds.is_a?(Float) != false || raise("Passed value for field obj.request_duration_seconds is not the expected type, validation failed.")
-      obj.request_started_at.is_a?(String) != false || raise("Passed value for field obj.request_started_at is not the expected type, validation failed.")
-      obj.request_finished_at.is_a?(String) != false || raise("Passed value for field obj.request_finished_at is not the expected type, validation failed.")
-      obj.request_body.is_a?(Hash) != false || raise("Passed value for field obj.request_body is not the expected type, validation failed.")
-      obj.request_http_method.is_a?(Vapi::LogRequestHttpMethod) != false || raise("Passed value for field obj.request_http_method is not the expected type, validation failed.")
-      obj.request_url.is_a?(String) != false || raise("Passed value for field obj.request_url is not the expected type, validation failed.")
-      obj.request_path.is_a?(String) != false || raise("Passed value for field obj.request_path is not the expected type, validation failed.")
+      obj.request_duration_seconds&.is_a?(Float) != false || raise("Passed value for field obj.request_duration_seconds is not the expected type, validation failed.")
+      obj.request_started_at&.is_a?(String) != false || raise("Passed value for field obj.request_started_at is not the expected type, validation failed.")
+      obj.request_finished_at&.is_a?(String) != false || raise("Passed value for field obj.request_finished_at is not the expected type, validation failed.")
+      obj.request_body&.is_a?(Hash) != false || raise("Passed value for field obj.request_body is not the expected type, validation failed.")
+      obj.request_http_method&.is_a?(Vapi::LogRequestHttpMethod) != false || raise("Passed value for field obj.request_http_method is not the expected type, validation failed.")
+      obj.request_url&.is_a?(String) != false || raise("Passed value for field obj.request_url is not the expected type, validation failed.")
+      obj.request_path&.is_a?(String) != false || raise("Passed value for field obj.request_path is not the expected type, validation failed.")
       obj.request_query&.is_a?(String) != false || raise("Passed value for field obj.request_query is not the expected type, validation failed.")
-      obj.response_http_code.is_a?(Float) != false || raise("Passed value for field obj.response_http_code is not the expected type, validation failed.")
+      obj.response_http_code&.is_a?(Float) != false || raise("Passed value for field obj.response_http_code is not the expected type, validation failed.")
       obj.request_ip_address&.is_a?(String) != false || raise("Passed value for field obj.request_ip_address is not the expected type, validation failed.")
       obj.request_origin&.is_a?(String) != false || raise("Passed value for field obj.request_origin is not the expected type, validation failed.")
       obj.response_body&.is_a?(Hash) != false || raise("Passed value for field obj.response_body is not the expected type, validation failed.")

data/lib/vapi_server_sdk/types/make_tool_with_tool_call.rb CHANGED Viewed

@@ -22,8 +22,6 @@ module Vapi
     #  `tool.destinations`. For others like the function tool, these can be custom
     #  configured.
     attr_reader :messages
-    # @return [String] The type of tool. "make" for Make tool.
-    attr_reader :type
     # @return [Vapi::ToolCall]
     attr_reader :tool_call
     # @return [Vapi::MakeToolMetadata]
@@ -63,7 +61,6 @@ module Vapi
     #  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 type [String] The type of tool. "make" for Make tool.
     # @param tool_call [Vapi::ToolCall]
     # @param metadata [Vapi::MakeToolMetadata]
     # @param function [Vapi::OpenAiFunction] This is the function definition of the tool.
@@ -83,11 +80,10 @@ module Vapi
     #  phoneNumber.serverUrl, then org.serverUrl.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::MakeToolWithToolCall]
-    def initialize(type:, tool_call:, metadata:, async: OMIT, messages: OMIT, function: OMIT, server: OMIT,
+    def initialize(tool_call:, metadata:, async: OMIT, messages: OMIT, function: OMIT, server: OMIT,
                    additional_properties: nil)
       @async = async if async != OMIT
       @messages = messages if messages != OMIT
-      @type = type
       @tool_call = tool_call
       @metadata = metadata
       @function = function if function != OMIT
@@ -96,7 +92,6 @@ module Vapi
       @_field_set = {
         "async": async,
         "messages": messages,
-        "type": type,
         "toolCall": tool_call,
         "metadata": metadata,
         "function": function,
@@ -118,7 +113,6 @@ module Vapi
         item = item.to_json
         Vapi::MakeToolWithToolCallMessagesItem.from_json(json_object: item)
       end
-      type = parsed_json["type"]
       if parsed_json["toolCall"].nil?
         tool_call = nil
       else
@@ -146,7 +140,6 @@ module Vapi
       new(
         async: async,
         messages: messages,
-        type: type,
         tool_call: tool_call,
         metadata: metadata,
         function: function,
@@ -171,7 +164,6 @@ module Vapi
     def self.validate_raw(obj:)
       obj.async&.is_a?(Boolean) != false || raise("Passed value for field obj.async is not the expected type, validation failed.")
       obj.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
-      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       Vapi::ToolCall.validate_raw(obj: obj.tool_call)
       Vapi::MakeToolMetadata.validate_raw(obj: obj.metadata)
       obj.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)

data/lib/vapi_server_sdk/types/programmatic_edge_condition.rb ADDED Viewed

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

data/lib/vapi_server_sdk/types/say.rb ADDED Viewed

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

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