vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/format_plan.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require_relative "format_plan_replacements_item"
+require "ostruct"
+require "json"
+
+module Vapi
+  class FormatPlan
+    # @return [Boolean] This determines whether the chunk is formatted before being sent to the voice
+    #  provider. This helps with enunciation. This includes phone numbers, emails and
+    #  addresses. Default `true`.
+    #  Usage:
+    #  - To rely on the voice provider's formatting logic, set this to `false`.
+    #  - To use ElevenLabs's `enableSsmlParsing` feature, set this to `false`.
+    #  If `voice.chunkPlan.enabled` is `false`, this is automatically `false` since
+    #  there's no chunk to format.
+    #  @default true
+    attr_reader :enabled
+    # @return [Float] This is the cutoff after which a number is converted to individual digits
+    #  instead of being spoken as words.
+    #  Example:
+    #  - If cutoff 2025, "12345" is converted to "1 2 3 4 5" while "1200" is converted
+    #  to "twelve hundred".
+    #  Usage:
+    #  - If your use case doesn't involve IDs like zip codes, set this to a high value.
+    #  - If your use case involves IDs that are shorter than 5 digits, set this to a
+    #  lower value.
+    #  @default 2025
+    attr_reader :number_to_digits_cutoff
+    # @return [Array<Vapi::FormatPlanReplacementsItem>] These are the custom replacements you can make to the chunk before it is sent to
+    #  the voice provider.
+    #  Usage:
+    #  - To replace a specific word or phrase with a different word or phrase, use the
+    #  `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`
+    #  - 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 []
+    attr_reader :replacements
+    # @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] This determines whether the chunk is formatted before being sent to the voice
+    #  provider. This helps with enunciation. This includes phone numbers, emails and
+    #  addresses. Default `true`.
+    #  Usage:
+    #  - To rely on the voice provider's formatting logic, set this to `false`.
+    #  - To use ElevenLabs's `enableSsmlParsing` feature, set this to `false`.
+    #  If `voice.chunkPlan.enabled` is `false`, this is automatically `false` since
+    #  there's no chunk to format.
+    #  @default true
+    # @param number_to_digits_cutoff [Float] This is the cutoff after which a number is converted to individual digits
+    #  instead of being spoken as words.
+    #  Example:
+    #  - If cutoff 2025, "12345" is converted to "1 2 3 4 5" while "1200" is converted
+    #  to "twelve hundred".
+    #  Usage:
+    #  - If your use case doesn't involve IDs like zip codes, set this to a high value.
+    #  - If your use case involves IDs that are shorter than 5 digits, set this to a
+    #  lower value.
+    #  @default 2025
+    # @param replacements [Array<Vapi::FormatPlanReplacementsItem>] These are the custom replacements you can make to the chunk before it is sent to
+    #  the voice provider.
+    #  Usage:
+    #  - To replace a specific word or phrase with a different word or phrase, use the
+    #  `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`
+    #  - 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 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)
+      @enabled = enabled if enabled != OMIT
+      @number_to_digits_cutoff = number_to_digits_cutoff if number_to_digits_cutoff != OMIT
+      @replacements = replacements if replacements != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "enabled": enabled,
+        "numberToDigitsCutoff": number_to_digits_cutoff,
+        "replacements": replacements
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of FormatPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::FormatPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      enabled = parsed_json["enabled"]
+      number_to_digits_cutoff = parsed_json["numberToDigitsCutoff"]
+      replacements = parsed_json["replacements"]&.map do |item|
+        item = item.to_json
+        Vapi::FormatPlanReplacementsItem.from_json(json_object: item)
+      end
+      new(
+        enabled: enabled,
+        number_to_digits_cutoff: number_to_digits_cutoff,
+        replacements: replacements,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FormatPlan 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.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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/format_plan_replacements_item.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "exact_replacement"
+require_relative "regex_replacement"
+
+module Vapi
+  class FormatPlanReplacementsItem
+    # @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::FormatPlanReplacementsItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of FormatPlanReplacementsItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::FormatPlanReplacementsItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "exact"
+                 Vapi::ExactReplacement.from_json(json_object: json_object)
+               when "regex"
+                 Vapi::RegexReplacement.from_json(json_object: json_object)
+               else
+                 Vapi::ExactReplacement.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 "exact"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "regex"
+        { **@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 "exact"
+        Vapi::ExactReplacement.validate_raw(obj: obj)
+      when "regex"
+        Vapi::RegexReplacement.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::ExactReplacement]
+    # @return [Vapi::FormatPlanReplacementsItem]
+    def self.exact(member:)
+      new(member: member, discriminant: "exact")
+    end
+
+    # @param member [Vapi::RegexReplacement]
+    # @return [Vapi::FormatPlanReplacementsItem]
+    def self.regex(member:)
+      new(member: member, discriminant: "regex")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/function_tool.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require_relative "function_tool_messages_item"
+require "date"
+require_relative "open_ai_function"
+require_relative "server"
+require "ostruct"
+require "json"
+
+module Vapi
+  class FunctionTool
+    # @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 [Array<Vapi::FunctionToolMessagesItem>] 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 [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 [Vapi::Server] This is the server that will be hit when this tool is requested by the model.
+    #  All requests will be sent with the call object among other things. You can find
+    #  more details in the Server URL documentation.
+    #  This overrides the serverUrl set on the org and the phoneNumber. Order of
+    #  precedence: highest tool.server.url, then assistant.serverUrl, then
+    #  phoneNumber.serverUrl, then org.serverUrl.
+    attr_reader :server
+    # @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 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 messages [Array<Vapi::FunctionToolMessagesItem>] 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 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 server [Vapi::Server] This is the server that will be hit when this tool is requested by the model.
+    #  All requests will be sent with the call object among other things. You can find
+    #  more details in the Server URL documentation.
+    #  This overrides the serverUrl set on the org and the phoneNumber. Order of
+    #  precedence: highest tool.server.url, then assistant.serverUrl, then
+    #  phoneNumber.serverUrl, then org.serverUrl.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::FunctionTool]
+    def initialize(id:, org_id:, created_at:, updated_at:, async: OMIT, messages: OMIT, function: OMIT, server: OMIT,
+                   additional_properties: nil)
+      @async = async if async != OMIT
+      @messages = messages if messages != OMIT
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @function = function if function != OMIT
+      @server = server if server != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "async": async,
+        "messages": messages,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at,
+        "function": function,
+        "server": server
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of FunctionTool
+    #
+    # @param json_object [String]
+    # @return [Vapi::FunctionTool]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      async = parsed_json["async"]
+      messages = parsed_json["messages"]&.map do |item|
+        item = item.to_json
+        Vapi::FunctionToolMessagesItem.from_json(json_object: item)
+      end
+      id = parsed_json["id"]
+      org_id = parsed_json["orgId"]
+      created_at = (DateTime.parse(parsed_json["createdAt"]) unless parsed_json["createdAt"].nil?)
+      updated_at = (DateTime.parse(parsed_json["updatedAt"]) unless parsed_json["updatedAt"].nil?)
+      if parsed_json["function"].nil?
+        function = nil
+      else
+        function = parsed_json["function"].to_json
+        function = Vapi::OpenAiFunction.from_json(json_object: function)
+      end
+      if parsed_json["server"].nil?
+        server = nil
+      else
+        server = parsed_json["server"].to_json
+        server = Vapi::Server.from_json(json_object: server)
+      end
+      new(
+        async: async,
+        messages: messages,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        function: function,
+        server: server,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FunctionTool 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.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.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.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/function_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 FunctionToolMessagesItem
+    # @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::FunctionToolMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of FunctionToolMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::FunctionToolMessagesItem]
+    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::FunctionToolMessagesItem]
+    def self.request_start(member:)
+      new(member: member, discriminant: "request-start")
+    end
+
+    # @param member [Vapi::ToolMessageComplete]
+    # @return [Vapi::FunctionToolMessagesItem]
+    def self.request_complete(member:)
+      new(member: member, discriminant: "request-complete")
+    end
+
+    # @param member [Vapi::ToolMessageFailed]
+    # @return [Vapi::FunctionToolMessagesItem]
+    def self.request_failed(member:)
+      new(member: member, discriminant: "request-failed")
+    end
+
+    # @param member [Vapi::ToolMessageDelayed]
+    # @return [Vapi::FunctionToolMessagesItem]
+    def self.request_response_delayed(member:)
+      new(member: member, discriminant: "request-response-delayed")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/function_tool_provider_details.rb

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