vapi_server_sdk 0.5.0 → 0.9.1

data/lib/vapi_server_sdk/types/response_error_event.rb

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

data/lib/vapi_server_sdk/types/response_object.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative "response_object_status"
+require_relative "response_output_message"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ResponseObject
+    # @return [String] Unique identifier for this Response
+    attr_reader :id
+    # @return [String] The object type
+    attr_reader :object
+    # @return [Float] Unix timestamp (in seconds) of when this Response was created
+    attr_reader :created_at
+    # @return [Vapi::ResponseObjectStatus] Status of the response
+    attr_reader :status
+    # @return [String] Error message if the response failed
+    attr_reader :error
+    # @return [Array<Vapi::ResponseOutputMessage>] Output messages from the model
+    attr_reader :output
+    # @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 id [String] Unique identifier for this Response
+    # @param object [String] The object type
+    # @param created_at [Float] Unix timestamp (in seconds) of when this Response was created
+    # @param status [Vapi::ResponseObjectStatus] Status of the response
+    # @param error [String] Error message if the response failed
+    # @param output [Array<Vapi::ResponseOutputMessage>] Output messages from the model
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ResponseObject]
+    def initialize(id:, object:, created_at:, status:, output:, error: OMIT, additional_properties: nil)
+      @id = id
+      @object = object
+      @created_at = created_at
+      @status = status
+      @error = error if error != OMIT
+      @output = output
+      @additional_properties = additional_properties
+      @_field_set = {
+        "id": id,
+        "object": object,
+        "created_at": created_at,
+        "status": status,
+        "error": error,
+        "output": output
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ResponseObject
+    #
+    # @param json_object [String]
+    # @return [Vapi::ResponseObject]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      object = parsed_json["object"]
+      created_at = parsed_json["created_at"]
+      status = parsed_json["status"]
+      error = parsed_json["error"]
+      output = parsed_json["output"]&.map do |item|
+        item = item.to_json
+        Vapi::ResponseOutputMessage.from_json(json_object: item)
+      end
+      new(
+        id: id,
+        object: object,
+        created_at: created_at,
+        status: status,
+        error: error,
+        output: output,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ResponseObject 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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.object.is_a?(String) != false || raise("Passed value for field obj.object is not the expected type, validation failed.")
+      obj.created_at.is_a?(Float) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
+      obj.status.is_a?(Vapi::ResponseObjectStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      obj.error&.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
+      obj.output.is_a?(Array) != false || raise("Passed value for field obj.output is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/response_object_status.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Vapi
+  # Status of the response
+  class ResponseObjectStatus
+    COMPLETED = "completed"
+    FAILED = "failed"
+    IN_PROGRESS = "in_progress"
+    INCOMPLETE = "incomplete"
+  end
+end

data/lib/vapi_server_sdk/types/response_output_message.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative "response_output_text"
+require_relative "response_output_message_status"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ResponseOutputMessage
+    # @return [String] The unique ID of the output message
+    attr_reader :id
+    # @return [Array<Vapi::ResponseOutputText>] Content of the output message
+    attr_reader :content
+    # @return [String] The role of the output message
+    attr_reader :role
+    # @return [Vapi::ResponseOutputMessageStatus] The status of the message
+    attr_reader :status
+    # @return [String] The type of the output message
+    attr_reader :type
+    # @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 id [String] The unique ID of the output message
+    # @param content [Array<Vapi::ResponseOutputText>] Content of the output message
+    # @param role [String] The role of the output message
+    # @param status [Vapi::ResponseOutputMessageStatus] The status of the message
+    # @param type [String] The type of the output message
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ResponseOutputMessage]
+    def initialize(id:, content:, role:, status:, type:, additional_properties: nil)
+      @id = id
+      @content = content
+      @role = role
+      @status = status
+      @type = type
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "content": content, "role": role, "status": status, "type": type }
+    end
+
+    # Deserialize a JSON object to an instance of ResponseOutputMessage
+    #
+    # @param json_object [String]
+    # @return [Vapi::ResponseOutputMessage]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      content = parsed_json["content"]&.map do |item|
+        item = item.to_json
+        Vapi::ResponseOutputText.from_json(json_object: item)
+      end
+      role = parsed_json["role"]
+      status = parsed_json["status"]
+      type = parsed_json["type"]
+      new(
+        id: id,
+        content: content,
+        role: role,
+        status: status,
+        type: type,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ResponseOutputMessage 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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.content.is_a?(Array) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
+      obj.role.is_a?(String) != false || raise("Passed value for field obj.role is not the expected type, validation failed.")
+      obj.status.is_a?(Vapi::ResponseOutputMessageStatus) != false || raise("Passed value for field obj.status 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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/response_output_message_status.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Vapi
+  # The status of the message
+  class ResponseOutputMessageStatus
+    IN_PROGRESS = "in_progress"
+    COMPLETED = "completed"
+    INCOMPLETE = "incomplete"
+  end
+end

data/lib/vapi_server_sdk/types/response_output_text.rb

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

data/lib/vapi_server_sdk/types/response_text_delta_event.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class ResponseTextDeltaEvent
+    # @return [Float] Index of the content part
+    attr_reader :content_index
+    # @return [String] Text delta being added
+    attr_reader :delta
+    # @return [String] ID of the output item
+    attr_reader :item_id
+    # @return [Float] Index of the output item
+    attr_reader :output_index
+    # @return [String] Event type
+    attr_reader :type
+    # @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_index [Float] Index of the content part
+    # @param delta [String] Text delta being added
+    # @param item_id [String] ID of the output item
+    # @param output_index [Float] Index of the output item
+    # @param type [String] Event type
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ResponseTextDeltaEvent]
+    def initialize(content_index:, delta:, item_id:, output_index:, type:, additional_properties: nil)
+      @content_index = content_index
+      @delta = delta
+      @item_id = item_id
+      @output_index = output_index
+      @type = type
+      @additional_properties = additional_properties
+      @_field_set = {
+        "content_index": content_index,
+        "delta": delta,
+        "item_id": item_id,
+        "output_index": output_index,
+        "type": type
+      }
+    end
+
+    # Deserialize a JSON object to an instance of ResponseTextDeltaEvent
+    #
+    # @param json_object [String]
+    # @return [Vapi::ResponseTextDeltaEvent]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      content_index = parsed_json["content_index"]
+      delta = parsed_json["delta"]
+      item_id = parsed_json["item_id"]
+      output_index = parsed_json["output_index"]
+      type = parsed_json["type"]
+      new(
+        content_index: content_index,
+        delta: delta,
+        item_id: item_id,
+        output_index: output_index,
+        type: type,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ResponseTextDeltaEvent 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_index.is_a?(Float) != false || raise("Passed value for field obj.content_index is not the expected type, validation failed.")
+      obj.delta.is_a?(String) != false || raise("Passed value for field obj.delta is not the expected type, validation failed.")
+      obj.item_id.is_a?(String) != false || raise("Passed value for field obj.item_id is not the expected type, validation failed.")
+      obj.output_index.is_a?(Float) != false || raise("Passed value for field obj.output_index 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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/response_text_done_event.rb

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