vellum_ai 0.3.15 → 0.14.74

data/lib/vellum_ai/types/vellum_variable.rb

@@ -1,56 +1,104 @@
 # frozen_string_literal: true
-
 require_relative "vellum_variable_type"
+require_relative "vellum_value"
+require_relative "vellum_variable_extensions"
+require "ostruct"
 require "json"
 
 module Vellum
   class VellumVariable
-    attr_reader :id, :key, :type, :additional_properties
+  # @return [String] 
+    attr_reader :id
+  # @return [String] 
+    attr_reader :key
+  # @return [Vellum::VellumVariableType] 
+    attr_reader :type
+  # @return [Boolean] 
+    attr_reader :required
+  # @return [Vellum::VellumValue] 
+    attr_reader :default
+  # @return [Vellum::VellumVariableExtensions] 
+    attr_reader :extensions
+  # @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]
-    # @param key [String]
-    # @param type [VELLUM_VARIABLE_TYPE]
+    # @param id [String] 
+    # @param key [String] 
+    # @param type [Vellum::VellumVariableType] 
+    # @param required [Boolean] 
+    # @param default [Vellum::VellumValue] 
+    # @param extensions [Vellum::VellumVariableExtensions] 
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [VellumVariable]
-    def initialize(id:, key:, type:, additional_properties: nil)
-      # @type [String]
+    # @return [Vellum::VellumVariable]
+    def initialize(id:, key:, type:, required: OMIT, default: OMIT, extensions: OMIT, additional_properties: nil)
       @id = id
-      # @type [String]
       @key = key
-      # @type [VELLUM_VARIABLE_TYPE]
       @type = type
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @required = required if required != OMIT
+      @default = default if default != OMIT
+      @extensions = extensions if extensions != OMIT
       @additional_properties = additional_properties
+      @_field_set = { "id": id, "key": key, "type": type, "required": required, "default": default, "extensions": extensions }.reject do | _k, v |
+  v == OMIT
+end
     end
-
-    # Deserialize a JSON object to an instance of VellumVariable
+# Deserialize a JSON object to an instance of VellumVariable
     #
-    # @param json_object [JSON]
-    # @return [VellumVariable]
+    # @param json_object [String] 
+    # @return [Vellum::VellumVariable]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      id = struct.id
-      key = struct.key
-      type = VELLUM_VARIABLE_TYPE.key(parsed_json["type"]) || parsed_json["type"]
-      new(id: id, key: key, type: type, additional_properties: struct)
+      id = parsed_json["id"]
+      key = parsed_json["key"]
+      type = parsed_json["type"]
+      required = parsed_json["required"]
+      unless parsed_json["default"].nil?
+        default = parsed_json["default"].to_json
+        default = Vellum::VellumValue.from_json(json_object: default)
+      else
+        default = nil
+      end
+      unless parsed_json["extensions"].nil?
+        extensions = parsed_json["extensions"].to_json
+        extensions = Vellum::VellumVariableExtensions.from_json(json_object: extensions)
+      else
+        extensions = nil
+      end
+      new(
+        id: id,
+        key: key,
+        type: type,
+        required: required,
+        default: default,
+        extensions: extensions,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of VellumVariable to a JSON object
+# Serialize an instance of VellumVariable to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "id": @id, "key": @key, "type": VELLUM_VARIABLE_TYPE[@type] || @type }.to_json
+    # @return [String]
+    def to_json
+      @_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.
+# 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]
+    # @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.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
-      obj.type.is_a?(VELLUM_VARIABLE_TYPE) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      obj.type.is_a?(Vellum::VellumVariableType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      obj.required&.is_a?(Boolean) != false || raise("Passed value for field obj.required is not the expected type, validation failed.")
+      obj.default.nil? || Vellum::VellumValue.validate_raw(obj: obj.default)
+      obj.extensions.nil? || Vellum::VellumVariableExtensions.validate_raw(obj: obj.extensions)
     end
   end
-end
+end

data/lib/vellum_ai/types/vellum_variable_extensions.rb

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

data/lib/vellum_ai/types/vellum_variable_type.rb

@@ -1,16 +1,32 @@
 # frozen_string_literal: true
 
 module Vellum
-  # @type [VELLUM_VARIABLE_TYPE]
-  VELLUM_VARIABLE_TYPE = {
-    string: "STRING",
-    number: "NUMBER",
-    json: "JSON",
-    chat_history: "CHAT_HISTORY",
-    search_results: "SEARCH_RESULTS",
-    error: "ERROR",
-    array: "ARRAY",
-    function_call: "FUNCTION_CALL",
-    image: "IMAGE"
-  }.freeze
-end
+# * `STRING` - STRING
+#  * `NUMBER` - NUMBER
+#  * `JSON` - JSON
+#  * `CHAT_HISTORY` - CHAT_HISTORY
+#  * `SEARCH_RESULTS` - SEARCH_RESULTS
+#  * `ERROR` - ERROR
+#  * `ARRAY` - ARRAY
+#  * `FUNCTION_CALL` - FUNCTION_CALL
+#  * `IMAGE` - IMAGE
+#  * `AUDIO` - AUDIO
+#  * `DOCUMENT` - DOCUMENT
+#  * `NULL` - NULL
+  class VellumVariableType
+
+    STRING = "STRING"
+    NUMBER = "NUMBER"
+    JSON_ = "JSON"
+    CHAT_HISTORY = "CHAT_HISTORY"
+    SEARCH_RESULTS = "SEARCH_RESULTS"
+    ERROR = "ERROR"
+    ARRAY = "ARRAY"
+    FUNCTION_CALL = "FUNCTION_CALL"
+    IMAGE = "IMAGE"
+    AUDIO = "AUDIO"
+    DOCUMENT = "DOCUMENT"
+    NULL = "NULL"
+
+  end
+end

data/lib/vellum_ai/types/vellum_workflow_execution_event.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+require "json"
+require_relative "workflow_execution_initiated_event"
+require_relative "workflow_execution_streaming_event"
+require_relative "workflow_execution_fulfilled_event"
+require_relative "workflow_execution_rejected_event"
+require_relative "workflow_execution_paused_event"
+require_relative "workflow_execution_resumed_event"
+require_relative "workflow_execution_snapshotted_event"
+
+module Vellum
+  class VellumWorkflowExecutionEvent
+
+
+# Deserialize a JSON object to an instance of VellumWorkflowExecutionEvent
+    #
+    # @param json_object [String] 
+    # @return [Vellum::VellumWorkflowExecutionEvent]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        Vellum::WorkflowExecutionInitiatedEvent.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::WorkflowExecutionInitiatedEvent.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::WorkflowExecutionStreamingEvent.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::WorkflowExecutionStreamingEvent.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::WorkflowExecutionFulfilledEvent.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::WorkflowExecutionFulfilledEvent.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::WorkflowExecutionRejectedEvent.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::WorkflowExecutionRejectedEvent.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::WorkflowExecutionPausedEvent.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::WorkflowExecutionPausedEvent.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::WorkflowExecutionResumedEvent.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::WorkflowExecutionResumedEvent.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::WorkflowExecutionSnapshottedEvent.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::WorkflowExecutionSnapshottedEvent.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+ return struct
+    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:)
+      begin
+        return Vellum::WorkflowExecutionInitiatedEvent.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::WorkflowExecutionStreamingEvent.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::WorkflowExecutionFulfilledEvent.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::WorkflowExecutionRejectedEvent.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::WorkflowExecutionPausedEvent.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::WorkflowExecutionResumedEvent.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::WorkflowExecutionSnapshottedEvent.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/workflow_deployment_event_executions_response.rb

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

data/lib/vellum_ai/types/workflow_deployment_history_item.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+require "date"
+require_relative "vellum_variable"
+require "ostruct"
+require "json"
+
+module Vellum
+  class WorkflowDeploymentHistoryItem
+  # @return [String] 
+    attr_reader :id
+  # @return [String] 
+    attr_reader :workflow_deployment_id
+  # @return [DateTime] 
+    attr_reader :timestamp
+  # @return [String] A human-readable label for the workflow deployment
+    attr_reader :label
+  # @return [String] A name that uniquely identifies this workflow deployment within its workspace
+    attr_reader :name
+  # @return [Array<Vellum::VellumVariable>] 
+    attr_reader :input_variables
+  # @return [Array<Vellum::VellumVariable>] 
+    attr_reader :output_variables
+  # @return [String] A human-readable description of the workflow deployment
+    attr_reader :description
+  # @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] 
+    # @param workflow_deployment_id [String] 
+    # @param timestamp [DateTime] 
+    # @param label [String] A human-readable label for the workflow deployment
+    # @param name [String] A name that uniquely identifies this workflow deployment within its workspace
+    # @param input_variables [Array<Vellum::VellumVariable>] 
+    # @param output_variables [Array<Vellum::VellumVariable>] 
+    # @param description [String] A human-readable description of the workflow deployment
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::WorkflowDeploymentHistoryItem]
+    def initialize(id:, workflow_deployment_id:, timestamp:, label:, name:, input_variables:, output_variables:, description: OMIT, additional_properties: nil)
+      @id = id
+      @workflow_deployment_id = workflow_deployment_id
+      @timestamp = timestamp
+      @label = label
+      @name = name
+      @input_variables = input_variables
+      @output_variables = output_variables
+      @description = description if description != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "workflow_deployment_id": workflow_deployment_id, "timestamp": timestamp, "label": label, "name": name, "input_variables": input_variables, "output_variables": output_variables, "description": description }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of WorkflowDeploymentHistoryItem
+    #
+    # @param json_object [String] 
+    # @return [Vellum::WorkflowDeploymentHistoryItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      workflow_deployment_id = parsed_json["workflow_deployment_id"]
+      timestamp = unless parsed_json["timestamp"].nil?
+  DateTime.parse(parsed_json["timestamp"])
+else
+  nil
+end
+      label = parsed_json["label"]
+      name = parsed_json["name"]
+      input_variables = parsed_json["input_variables"]&.map do | item |
+  item = item.to_json
+  Vellum::VellumVariable.from_json(json_object: item)
+end
+      output_variables = parsed_json["output_variables"]&.map do | item |
+  item = item.to_json
+  Vellum::VellumVariable.from_json(json_object: item)
+end
+      description = parsed_json["description"]
+      new(
+        id: id,
+        workflow_deployment_id: workflow_deployment_id,
+        timestamp: timestamp,
+        label: label,
+        name: name,
+        input_variables: input_variables,
+        output_variables: output_variables,
+        description: description,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of WorkflowDeploymentHistoryItem to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_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.workflow_deployment_id.is_a?(String) != false || raise("Passed value for field obj.workflow_deployment_id is not the expected type, validation failed.")
+      obj.timestamp.is_a?(DateTime) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
+      obj.label.is_a?(String) != false || raise("Passed value for field obj.label 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.input_variables.is_a?(Array) != false || raise("Passed value for field obj.input_variables is not the expected type, validation failed.")
+      obj.output_variables.is_a?(Array) != false || raise("Passed value for field obj.output_variables 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.")
+    end
+  end
+end