vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/end_call_tool.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require_relative "end_call_tool_messages_item"
+require "date"
+require_relative "open_ai_function"
+require_relative "server"
+require "ostruct"
+require "json"
+
+module Vapi
+  class EndCallTool
+    # @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::EndCallToolMessagesItem>] 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::EndCallToolMessagesItem>] 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::EndCallTool]
+    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 EndCallTool
+    #
+    # @param json_object [String]
+    # @return [Vapi::EndCallTool]
+    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::EndCallToolMessagesItem.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 EndCallTool 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/end_call_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 EndCallToolMessagesItem
+    # @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::EndCallToolMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of EndCallToolMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::EndCallToolMessagesItem]
+    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::EndCallToolMessagesItem]
+    def self.request_start(member:)
+      new(member: member, discriminant: "request-start")
+    end
+
+    # @param member [Vapi::ToolMessageComplete]
+    # @return [Vapi::EndCallToolMessagesItem]
+    def self.request_complete(member:)
+      new(member: member, discriminant: "request-complete")
+    end
+
+    # @param member [Vapi::ToolMessageFailed]
+    # @return [Vapi::EndCallToolMessagesItem]
+    def self.request_failed(member:)
+      new(member: member, discriminant: "request-failed")
+    end
+
+    # @param member [Vapi::ToolMessageDelayed]
+    # @return [Vapi::EndCallToolMessagesItem]
+    def self.request_response_delayed(member:)
+      new(member: member, discriminant: "request-response-delayed")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/error.rb

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

data/lib/vapi_server_sdk/types/exact_replacement.rb

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

data/lib/vapi_server_sdk/types/file.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+require_relative "file_status"
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class File
+    # @return [String]
+    attr_reader :object
+    # @return [Vapi::FileStatus]
+    attr_reader :status
+    # @return [String] This is the name of the file. This is just for your own reference.
+    attr_reader :name
+    # @return [String]
+    attr_reader :original_name
+    # @return [Float]
+    attr_reader :bytes
+    # @return [String]
+    attr_reader :purpose
+    # @return [String]
+    attr_reader :mimetype
+    # @return [String]
+    attr_reader :key
+    # @return [String]
+    attr_reader :path
+    # @return [String]
+    attr_reader :bucket
+    # @return [String]
+    attr_reader :url
+    # @return [Hash{String => Object}]
+    attr_reader :metadata
+    # @return [String] This is the unique identifier for the file.
+    attr_reader :id
+    # @return [String] This is the unique identifier for the org that this file belongs to.
+    attr_reader :org_id
+    # @return [DateTime] This is the ISO 8601 date-time string of when the file was created.
+    attr_reader :created_at
+    # @return [DateTime] This is the ISO 8601 date-time string of when the file was last updated.
+    attr_reader :updated_at
+    # @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 object [String]
+    # @param status [Vapi::FileStatus]
+    # @param name [String] This is the name of the file. This is just for your own reference.
+    # @param original_name [String]
+    # @param bytes [Float]
+    # @param purpose [String]
+    # @param mimetype [String]
+    # @param key [String]
+    # @param path [String]
+    # @param bucket [String]
+    # @param url [String]
+    # @param metadata [Hash{String => Object}]
+    # @param id [String] This is the unique identifier for the file.
+    # @param org_id [String] This is the unique identifier for the org that this file belongs to.
+    # @param created_at [DateTime] This is the ISO 8601 date-time string of when the file was created.
+    # @param updated_at [DateTime] This is the ISO 8601 date-time string of when the file was last updated.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::File]
+    def initialize(id:, org_id:, created_at:, updated_at:, object: OMIT, status: OMIT, name: OMIT, original_name: OMIT, bytes: OMIT, purpose: OMIT,
+                   mimetype: OMIT, key: OMIT, path: OMIT, bucket: OMIT, url: OMIT, metadata: OMIT, additional_properties: nil)
+      @object = object if object != OMIT
+      @status = status if status != OMIT
+      @name = name if name != OMIT
+      @original_name = original_name if original_name != OMIT
+      @bytes = bytes if bytes != OMIT
+      @purpose = purpose if purpose != OMIT
+      @mimetype = mimetype if mimetype != OMIT
+      @key = key if key != OMIT
+      @path = path if path != OMIT
+      @bucket = bucket if bucket != OMIT
+      @url = url if url != OMIT
+      @metadata = metadata if metadata != OMIT
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @additional_properties = additional_properties
+      @_field_set = {
+        "object": object,
+        "status": status,
+        "name": name,
+        "originalName": original_name,
+        "bytes": bytes,
+        "purpose": purpose,
+        "mimetype": mimetype,
+        "key": key,
+        "path": path,
+        "bucket": bucket,
+        "url": url,
+        "metadata": metadata,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of File
+    #
+    # @param json_object [String]
+    # @return [Vapi::File]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      object = parsed_json["object"]
+      status = parsed_json["status"]
+      name = parsed_json["name"]
+      original_name = parsed_json["originalName"]
+      bytes = parsed_json["bytes"]
+      purpose = parsed_json["purpose"]
+      mimetype = parsed_json["mimetype"]
+      key = parsed_json["key"]
+      path = parsed_json["path"]
+      bucket = parsed_json["bucket"]
+      url = parsed_json["url"]
+      metadata = parsed_json["metadata"]
+      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?)
+      new(
+        object: object,
+        status: status,
+        name: name,
+        original_name: original_name,
+        bytes: bytes,
+        purpose: purpose,
+        mimetype: mimetype,
+        key: key,
+        path: path,
+        bucket: bucket,
+        url: url,
+        metadata: metadata,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of File 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.object&.is_a?(String) != false || raise("Passed value for field obj.object is not the expected type, validation failed.")
+      obj.status&.is_a?(Vapi::FileStatus) != false || raise("Passed value for field obj.status 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.")
+      obj.original_name&.is_a?(String) != false || raise("Passed value for field obj.original_name is not the expected type, validation failed.")
+      obj.bytes&.is_a?(Float) != false || raise("Passed value for field obj.bytes is not the expected type, validation failed.")
+      obj.purpose&.is_a?(String) != false || raise("Passed value for field obj.purpose is not the expected type, validation failed.")
+      obj.mimetype&.is_a?(String) != false || raise("Passed value for field obj.mimetype is not the expected type, validation failed.")
+      obj.key&.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
+      obj.path&.is_a?(String) != false || raise("Passed value for field obj.path is not the expected type, validation failed.")
+      obj.bucket&.is_a?(String) != false || raise("Passed value for field obj.bucket is not the expected type, validation failed.")
+      obj.url&.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+      obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
+      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.org_id.is_a?(String) != false || raise("Passed value for field obj.org_id is not the expected type, validation failed.")
+      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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/file_status.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vapi
+  class FileStatus
+    INDEXED = "indexed"
+    NOT_INDEXED = "not_indexed"
+  end
+end