retab 0.1.6 → 0.1.7

data/lib/retab/workflow_blocks/workflow_version_field_diff.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class WorkflowVersionFieldDiff < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      field: :field,
+      from_value: :from_value,
+      to_value: :to_value
+    }.freeze
+
+    attr_accessor(
+      :field,
+      :from_value,
+      :to_value
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @field = hash[:field]
+      @from_value = hash[:from_value]
+      @to_value = hash[:to_value]
+    end
+  end
+end

data/lib/retab/workflow_blocks.rb

@@ -112,6 +112,140 @@ module Retab
       result
     end
 
+    # List Block Versions
+    # @param workflow_id [String]
+    # @param block_id [String, nil] Filter by stable block ID
+    # @param workflow_version_id [String, nil] Filter by workflow version ID
+    # @param before [String, nil] Block version cursor before
+    # @param after [String, nil] Block version cursor after
+    # @param limit [Integer, nil] Maximum number of block versions to return
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::PaginatedList<Retab::WorkflowBlockVersion>]
+    def list_versions(
+      workflow_id:,
+      block_id: nil,
+      workflow_version_id: nil,
+      before: nil,
+      after: nil,
+      limit: 50,
+      request_options: {}
+    )
+      params = {
+        "workflow_id" => workflow_id,
+        "block_id" => block_id,
+        "workflow_version_id" => workflow_version_id,
+        "before" => before,
+        "after" => after,
+        "limit" => limit
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/v1/workflows/blocks/versions",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = -> (cursor) {
+        list_versions(
+          workflow_id: workflow_id,
+          block_id: block_id,
+          workflow_version_id: workflow_version_id,
+          before: before,
+          after: cursor,
+          limit: limit,
+          request_options: request_options
+        )
+      }
+      Retab::PaginatedList.from_response(
+        response,
+        model: Retab::WorkflowBlockVersion,
+        filters: {
+          workflow_id: workflow_id,
+          block_id: block_id,
+          workflow_version_id: workflow_version_id,
+          before: before,
+          limit: limit
+        },
+        fetch_next: fetch_next
+      )
+    end
+
+    # Diff Block Versions
+    # @param from_block_version_id [String]
+    # @param to_block_version_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowBlockVersionDiff]
+    def list_diff(
+      from_block_version_id:,
+      to_block_version_id:,
+      request_options: {}
+    )
+      params = {
+        "from_block_version_id" => from_block_version_id,
+        "to_block_version_id" => to_block_version_id
+      }
+      response = @client.request(
+        method: :get,
+        path: "/v1/workflows/blocks/versions/diff",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      result = Retab::WorkflowBlockVersionDiff.new(response.body)
+      result.last_response = Retab::Types::ApiResponse.new(
+        http_status: response.code.to_i,
+        http_headers: response.each_header.to_h,
+        request_id: response["x-request-id"]
+      )
+      result
+    end
+
+    # Get Block Version
+    # @param block_version_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowBlockVersion]
+    def get_version(
+      block_version_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/workflows/blocks/versions/#{Retab::Util.encode_path(block_version_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::WorkflowBlockVersion.new(response.body)
+      result.last_response = Retab::Types::ApiResponse.new(
+        http_status: response.code.to_i,
+        http_headers: response.each_header.to_h,
+        request_id: response["x-request-id"]
+      )
+      result
+    end
+
+    # Restore Block Version
+    # @param block_version_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowBlock]
+    def create_version_restore(
+      block_version_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :post,
+        path: "/v1/workflows/blocks/versions/#{Retab::Util.encode_path(block_version_id)}/restore",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::WorkflowBlock.new(response.body)
+      result.last_response = Retab::Types::ApiResponse.new(
+        http_status: response.code.to_i,
+        http_headers: response.each_header.to_h,
+        request_id: response["x-request-id"]
+      )
+      result
+    end
+
     # Get Block
     # @param block_id [String]
     # @param workflow_id [String, nil] Disambiguates a block id that is shared by more than one workflow. Required only when the block id is not unique within your organization — otherwise the call returns 409 listing the colliding workflow_ids. Server-generated block IDs are always unique and never need this.
@@ -220,7 +354,7 @@ module Retab
       nil
     end
 
-    # Validate Block Config Dry Run
+    # Validate Block Config
     # @param block_id [String]
     # @param config [Hash{String => Object}] Assembled block config to validate.
     # @param config_mode [Retab::Types::ValidateWorkflowBlockConfigRequestConfigMode, nil] How to apply the config before validation. 'replace' validates the config as the full block config; 'merge' validates the result of merging it into the existing block config.

data/lib/retab/workflow_edges/workflow_edge_version.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class WorkflowEdgeVersion < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      id: :id,
+      edge_id: :edge_id,
+      workflow_id: :workflow_id,
+      workflow_version_id: :workflow_version_id,
+      source: :source,
+      source_handle: :source_handle,
+      target: :target,
+      target_handle: :target_handle,
+      animated: :animated,
+      created_at: :created_at
+    }.freeze
+
+    attr_accessor(
+      :id,
+      :edge_id,
+      :workflow_id,
+      :workflow_version_id,
+      :source,
+      :source_handle,
+      :target,
+      :target_handle,
+      :animated,
+      :created_at
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @id = hash[:id]
+      @edge_id = hash[:edge_id]
+      @workflow_id = hash[:workflow_id]
+      @workflow_version_id = hash[:workflow_version_id]
+      @source = hash[:source]
+      @source_handle = hash[:source_handle]
+      @target = hash[:target]
+      @target_handle = hash[:target_handle]
+      @animated = hash[:animated].nil? ? true : hash[:animated]
+      @created_at = hash[:created_at]
+    end
+  end
+end

data/lib/retab/workflow_edges/workflow_edge_version_diff.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class WorkflowEdgeVersionDiff < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      from_edge_version_id: :from_edge_version_id,
+      to_edge_version_id: :to_edge_version_id,
+      edge_id: :edge_id,
+      changes: :changes
+    }.freeze
+
+    attr_accessor(
+      :from_edge_version_id,
+      :to_edge_version_id,
+      :edge_id,
+      :changes
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @from_edge_version_id = hash[:from_edge_version_id]
+      @to_edge_version_id = hash[:to_edge_version_id]
+      @edge_id = hash[:edge_id]
+      @changes = (hash[:changes] || []).map { |item| item ? Retab::WorkflowVersionFieldDiff.new(item) : nil }
+    end
+  end
+end

data/lib/retab/workflow_edges.rb

@@ -110,6 +110,140 @@ module Retab
       result
     end
 
+    # List Edge Versions
+    # @param workflow_id [String]
+    # @param edge_id [String, nil] Filter by stable edge ID
+    # @param workflow_version_id [String, nil] Filter by workflow version ID
+    # @param before [String, nil] Edge version cursor before
+    # @param after [String, nil] Edge version cursor after
+    # @param limit [Integer, nil] Maximum number of edge versions to return
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::PaginatedList<Retab::WorkflowEdgeVersion>]
+    def list_versions(
+      workflow_id:,
+      edge_id: nil,
+      workflow_version_id: nil,
+      before: nil,
+      after: nil,
+      limit: 50,
+      request_options: {}
+    )
+      params = {
+        "workflow_id" => workflow_id,
+        "edge_id" => edge_id,
+        "workflow_version_id" => workflow_version_id,
+        "before" => before,
+        "after" => after,
+        "limit" => limit
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/v1/workflows/edges/versions",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = -> (cursor) {
+        list_versions(
+          workflow_id: workflow_id,
+          edge_id: edge_id,
+          workflow_version_id: workflow_version_id,
+          before: before,
+          after: cursor,
+          limit: limit,
+          request_options: request_options
+        )
+      }
+      Retab::PaginatedList.from_response(
+        response,
+        model: Retab::WorkflowEdgeVersion,
+        filters: {
+          workflow_id: workflow_id,
+          edge_id: edge_id,
+          workflow_version_id: workflow_version_id,
+          before: before,
+          limit: limit
+        },
+        fetch_next: fetch_next
+      )
+    end
+
+    # Diff Edge Versions
+    # @param from_edge_version_id [String]
+    # @param to_edge_version_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowEdgeVersionDiff]
+    def list_diff(
+      from_edge_version_id:,
+      to_edge_version_id:,
+      request_options: {}
+    )
+      params = {
+        "from_edge_version_id" => from_edge_version_id,
+        "to_edge_version_id" => to_edge_version_id
+      }
+      response = @client.request(
+        method: :get,
+        path: "/v1/workflows/edges/versions/diff",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      result = Retab::WorkflowEdgeVersionDiff.new(response.body)
+      result.last_response = Retab::Types::ApiResponse.new(
+        http_status: response.code.to_i,
+        http_headers: response.each_header.to_h,
+        request_id: response["x-request-id"]
+      )
+      result
+    end
+
+    # Get Edge Version
+    # @param edge_version_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowEdgeVersion]
+    def get_version(
+      edge_version_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/workflows/edges/versions/#{Retab::Util.encode_path(edge_version_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::WorkflowEdgeVersion.new(response.body)
+      result.last_response = Retab::Types::ApiResponse.new(
+        http_status: response.code.to_i,
+        http_headers: response.each_header.to_h,
+        request_id: response["x-request-id"]
+      )
+      result
+    end
+
+    # Restore Edge Version
+    # @param edge_version_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowEdgeDoc]
+    def create_version_restore(
+      edge_version_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :post,
+        path: "/v1/workflows/edges/versions/#{Retab::Util.encode_path(edge_version_id)}/restore",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::WorkflowEdgeDoc.new(response.body)
+      result.last_response = Retab::Types::ApiResponse.new(
+        http_status: response.code.to_i,
+        http_headers: response.each_header.to_h,
+        request_id: response["x-request-id"]
+      )
+      result
+    end
+
     # Get Edge
     # @param edge_id [String]
     # @param request_options [Hash] (see Retab::Types::RequestOptions)

data/lib/retab/workflow_experiments/artifact_drift.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class ArtifactDrift < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      status: :status,
+      affected_targets: :affected_targets,
+      detail: :detail
+    }.freeze
+
+    attr_accessor(
+      :status,
+      :affected_targets,
+      :detail
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @status = hash[:status].nil? ? "unknown" : hash[:status]
+      @affected_targets = (hash[:affected_targets] || [])
+      @detail = hash[:detail]
+    end
+  end
+end

data/lib/retab/workflow_experiments/artifact_freshness.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class ArtifactFreshness < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      status: :status,
+      reasons: :reasons,
+      validity_fingerprint: :validity_fingerprint,
+      input_fingerprint: :input_fingerprint,
+      baseline_run_id: :baseline_run_id
+    }.freeze
+
+    attr_accessor(
+      :status,
+      :reasons,
+      :validity_fingerprint,
+      :input_fingerprint,
+      :baseline_run_id
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @status = hash[:status].nil? ? "unknown" : hash[:status]
+      @reasons = (hash[:reasons] || [])
+      @validity_fingerprint = hash[:validity_fingerprint]
+      @input_fingerprint = hash[:input_fingerprint]
+      @baseline_run_id = hash[:baseline_run_id]
+    end
+  end
+end

data/lib/retab/workflow_experiments/workflow_experiment.rb

@@ -19,8 +19,10 @@ module Retab
       block_type: :block_type,
       score: :score,
       is_stale: :is_stale,
+      freshness: :freshness,
       schema_drift: :schema_drift,
-      schema_drift_detail: :schema_drift_detail
+      schema_drift_detail: :schema_drift_detail,
+      drift: :drift
     }.freeze
 
     attr_accessor(
@@ -37,8 +39,10 @@ module Retab
       :block_type,
       :score,
       :is_stale,
+      :freshness,
       :schema_drift,
-      :schema_drift_detail
+      :schema_drift_detail,
+      :drift
     )
 
     def initialize(json)
@@ -57,8 +61,10 @@ module Retab
       @block_type = hash[:block_type]
       @score = hash[:score]
       @is_stale = hash[:is_stale].nil? ? false : hash[:is_stale]
+      @freshness = hash[:freshness] ? Retab::ArtifactFreshness.new(hash[:freshness]) : nil
       @schema_drift = hash[:schema_drift].nil? ? "unknown" : hash[:schema_drift]
       @schema_drift_detail = hash[:schema_drift_detail]
+      @drift = hash[:drift] ? Retab::ArtifactDrift.new(hash[:drift]) : nil
     end
   end
 end

data/lib/retab/workflow_review_versions.rb

@@ -10,7 +10,7 @@ module Retab
       @client = client
     end
 
-    # List Review Versions Route
+    # List Review Versions
     # @param review_id [String] Required: the review whose versions to list.
     # @param before [String, nil]
     # @param after [String, nil]
@@ -54,7 +54,7 @@ module Retab
       )
     end
 
-    # Create Review Version Route
+    # Create Review Version
     # @param review_id [String]
     # @param parent_id [String]
     # @param snapshot [Hash{String => Object}] The full reviewed snapshot to store as an immutable version. The object must match the gated block type: extract uses the raw output object; classifier uses {'category': string}; split uses {'documents': [{'name': string, 'pages': positive sorted int[]}]}; for_each uses {'partitions': [{'key': string, 'pages': positive sorted int[]}]}. The server validates the shape and stores the exact submitted object when valid.
@@ -90,7 +90,7 @@ module Retab
       result
     end
 
-    # Get Review Version Route
+    # Get Review Version
     # @param version_id [String]
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
     # @return [Retab::ReviewVersion]

data/lib/retab/workflow_reviews.rb

@@ -14,7 +14,7 @@ module Retab
       @versions ||= Retab::WorkflowReviewVersions.new(@client)
     end
 
-    # List Reviews Route
+    # List Reviews
     # @param workflow_id [String, nil]
     # @param run_id [String, nil]
     # @param block_id [String, nil]
@@ -87,7 +87,7 @@ module Retab
       )
     end
 
-    # Get Review Route
+    # Get Review
     # @param review_id [String]
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
     # @return [Retab::Review]
@@ -110,7 +110,7 @@ module Retab
       result
     end
 
-    # Approve Review Route
+    # Approve Review
     # @param review_id [String]
     # @param version_id [String] Exact content-addressed key of the version to approve.
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
@@ -139,7 +139,7 @@ module Retab
       result
     end
 
-    # Reject Review Route
+    # Reject Review
     # @param review_id [String]
     # @param version_id [String] Exact content-addressed key of the version to reject.
     # @param reason [String] Required, non-empty rejection reason.

data/lib/retab/workflow_runs.rb

@@ -108,7 +108,7 @@ module Retab
       )
     end
 
-    # Create Workflow Run Route
+    # Create Workflow Run
     # @param workflow_id [String] Workflow id for the fresh run.
     # @param documents [Hash{String => Retab::MimeData, Retab::FileRef, Pathname, IO, String, Hash}, nil] Mapping of start_document block IDs to their input documents.
     # @param json_inputs [Hash{String => Object}, nil] Mapping of start-json block IDs to their input JSON data.

data/lib/retab/workflow_spec.rb

@@ -10,71 +10,20 @@ module Retab
       @client = client
     end
 
-    # Apply Workflow Spec
-    # @param yaml_definition [String] Workflow YAML definition
-    # @param request_options [Hash] (see Retab::Types::RequestOptions)
-    # @return [Retab::DeclarativeApplyResponse]
-    def apply(
-      yaml_definition:,
-      request_options: {}
-    )
-      body = {
-        "yaml_definition" => yaml_definition
-      }
-      response = @client.request(
-        method: :post,
-        path: "/v1/workflows/spec/apply",
-        auth: true,
-        body: body,
-        request_options: request_options
-      )
-      result = Retab::DeclarativeApplyResponse.new(response.body)
-      result.last_response = Retab::Types::ApiResponse.new(
-        http_status: response.code.to_i,
-        http_headers: response.each_header.to_h,
-        request_id: response["x-request-id"]
-      )
-      result
-    end
-
-    # Plan Workflow Spec
-    # @param yaml_definition [String] Workflow YAML definition
-    # @param request_options [Hash] (see Retab::Types::RequestOptions)
-    # @return [Retab::DeclarativePlanResponse]
-    def plan(
-      yaml_definition:,
-      request_options: {}
-    )
-      body = {
-        "yaml_definition" => yaml_definition
-      }
-      response = @client.request(
-        method: :post,
-        path: "/v1/workflows/spec/plan",
-        auth: true,
-        body: body,
-        request_options: request_options
-      )
-      result = Retab::DeclarativePlanResponse.new(response.body)
-      result.last_response = Retab::Types::ApiResponse.new(
-        http_status: response.code.to_i,
-        http_headers: response.each_header.to_h,
-        request_id: response["x-request-id"]
-      )
-      result
-    end
-
     # Validate Workflow Spec
     # @param yaml_definition [String] Workflow YAML definition
+    # @param project_id [String, nil] Project that should own a workflow created from this spec. Required when applying a spec that creates a new workflow.
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
     # @return [Retab::DeclarativeValidationResponse]
     def validate(
       yaml_definition:,
+      project_id: nil,
       request_options: {}
     )
       body = {
-        "yaml_definition" => yaml_definition
-      }
+        "yaml_definition" => yaml_definition,
+        "project_id" => project_id
+      }.compact
       response = @client.request(
         method: :post,
         path: "/v1/workflows/spec/validate",
@@ -101,7 +50,7 @@ module Retab
     )
       response = @client.request(
         method: :get,
-        path: "/v1/workflows/spec/#{Retab::Util.encode_path(workflow_id)}",
+        path: "/v1/workflows/#{Retab::Util.encode_path(workflow_id)}/spec",
         auth: true,
         request_options: request_options
       )

data/lib/retab/workflow_test_runs/workflow_test_run.rb

@@ -15,7 +15,8 @@ module Retab
       target: :target,
       test_id: :test_id,
       total_tests: :total_tests,
-      counts: :counts
+      counts: :counts,
+      freshness: :freshness
     }.freeze
 
     attr_accessor(
@@ -28,7 +29,8 @@ module Retab
       :target,
       :test_id,
       :total_tests,
-      :counts
+      :counts,
+      :freshness
     )
 
     def initialize(json)
@@ -61,6 +63,7 @@ module Retab
       @test_id = hash[:test_id]
       @total_tests = hash[:total_tests]
       @counts = hash[:counts] ? Retab::BlockTestBatchExecutionCounts.new(hash[:counts]) : nil
+      @freshness = hash[:freshness] ? Retab::ArtifactFreshness.new(hash[:freshness]) : nil
     end
   end
 end