retab 0.1.0

data/lib/retab/workflow_block_executions.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require 'json'
+
+module Retab
+  class WorkflowBlockExecutions
+    def initialize(client)
+      @client = client
+    end
+
+    # List Block Executions
+    # @param run_id [String]
+    # @param block_id [String]
+    # @param limit [Integer, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Types::ListStruct<Retab::StoredBlockExecution>]
+    def list(
+      run_id:,
+      block_id:,
+      limit: 20,
+      request_options: {}
+    )
+      params = {
+        'run_id' => run_id,
+        'block_id' => block_id,
+        'limit' => limit
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: '/v1/workflows/blocks/executions',
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      Retab::Types::ListStruct.from_response(
+        response,
+        model: Retab::StoredBlockExecution,
+        filters: { run_id: run_id, block_id: block_id, limit: limit }
+      )
+    end
+
+    # Create Block Execution
+    # @param run_id [String] Workflow run id that owns the step.
+    # @param block_id [String] Workflow block id to execute.
+    # @param step_id [String, nil] Optional concrete step id whose inputs should be used. When omitted, the block id is used as the canonical step lookup key.
+    # @param n_consensus [Integer, nil] Optional override for n_consensus on extract / split / classifier blocks. Must be 3, 5, or 7.
+    # @param check_eligibility [Boolean, nil] Whether to verify the upstream subgraph hasn't drifted since the source run. Disable only for explicit force-rerun flows.
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::StoredBlockExecution]
+    def create(
+      run_id:,
+      block_id:,
+      step_id: nil,
+      n_consensus: nil,
+      check_eligibility: nil,
+      request_options: {}
+    )
+      body = {
+        'run_id' => run_id,
+        'block_id' => block_id,
+        'step_id' => step_id,
+        'n_consensus' => n_consensus,
+        'check_eligibility' => check_eligibility
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: '/v1/workflows/blocks/executions',
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::StoredBlockExecution.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
+  end
+end

data/lib/retab/workflow_blocks/update_workflow_block_request.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class UpdateWorkflowBlockRequest < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      label: :label,
+      position_x: :position_x,
+      position_y: :position_y,
+      width: :width,
+      height: :height,
+      config: :config,
+      parent_id: :parent_id,
+      config_mode: :config_mode
+    }.freeze
+
+    attr_accessor \
+      :label,
+      :position_x,
+      :position_y,
+      :width,
+      :height,
+      :config,
+      :parent_id,
+      :config_mode
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @label = hash[:label]
+      @position_x = hash[:position_x]
+      @position_y = hash[:position_y]
+      @width = hash[:width]
+      @height = hash[:height]
+      @config = hash[:config] || {}
+      @parent_id = hash[:parent_id]
+      @config_mode = hash[:config_mode]
+    end
+  end
+end

data/lib/retab/workflow_blocks/workflow_block.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class WorkflowBlock < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      id: :id,
+      workflow_id: :workflow_id,
+      type: :type,
+      label: :label,
+      position_x: :position_x,
+      position_y: :position_y,
+      width: :width,
+      height: :height,
+      config: :config,
+      parent_id: :parent_id,
+      updated_at: :updated_at,
+      resolved_schemas: :resolved_schemas
+    }.freeze
+
+    attr_accessor \
+      :id,
+      :workflow_id,
+      :type,
+      :label,
+      :position_x,
+      :position_y,
+      :width,
+      :height,
+      :config,
+      :parent_id,
+      :updated_at,
+      :resolved_schemas
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @id = hash[:id]
+      @workflow_id = hash[:workflow_id]
+      @type = hash[:type]
+      @label = hash[:label]
+      @position_x = hash[:position_x]
+      @position_y = hash[:position_y]
+      @width = hash[:width]
+      @height = hash[:height]
+      @config = hash[:config] || {}
+      @parent_id = hash[:parent_id]
+      @updated_at = hash[:updated_at]
+      @resolved_schemas = hash[:resolved_schemas] || {}
+    end
+  end
+end

data/lib/retab/workflow_blocks/workflow_block_create_request.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class WorkflowBlockCreateRequest < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      workflow_id: :workflow_id,
+      id: :id,
+      type: :type,
+      label: :label,
+      position_x: :position_x,
+      position_y: :position_y,
+      width: :width,
+      height: :height,
+      config: :config,
+      parent_id: :parent_id
+    }.freeze
+
+    attr_accessor \
+      :workflow_id,
+      :id,
+      :type,
+      :label,
+      :position_x,
+      :position_y,
+      :width,
+      :height,
+      :config,
+      :parent_id
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @workflow_id = hash[:workflow_id]
+      @id = hash[:id]
+      @type = hash[:type]
+      @label = hash[:label]
+      @position_x = hash[:position_x]
+      @position_y = hash[:position_y]
+      @width = hash[:width]
+      @height = hash[:height]
+      @config = hash[:config] || {}
+      @parent_id = hash[:parent_id]
+    end
+  end
+end

data/lib/retab/workflow_blocks.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require 'json'
+
+module Retab
+  class WorkflowBlocks
+    def initialize(client)
+      @client = client
+    end
+
+    # List Blocks
+    # @param workflow_id [String]
+    # @param before [String, nil] Block id cursor: return the page before this id (mutually exclusive with ``after``).
+    # @param after [String, nil] Block id cursor: return the page after this id (mutually exclusive with ``before``).
+    # @param limit [Integer, nil] Maximum number of blocks to return per page (1-200).
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Types::ListStruct<Retab::WorkflowBlock>]
+    def list(
+      workflow_id:,
+      before: nil,
+      after: nil,
+      limit: 100,
+      request_options: {}
+    )
+      params = {
+        'workflow_id' => workflow_id,
+        'before' => before,
+        'after' => after,
+        'limit' => limit
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: '/v1/workflows/blocks',
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = ->(cursor) {
+        list(
+          workflow_id: workflow_id,
+          before: before,
+          after: cursor,
+          limit: limit,
+          request_options: request_options
+        )
+      }
+      Retab::Types::ListStruct.from_response(
+        response,
+        model: Retab::WorkflowBlock,
+        filters: { workflow_id: workflow_id, before: before, limit: limit },
+        fetch_next: fetch_next
+      )
+    end
+
+    # Create Block
+    # @param workflow_id [String] Workflow to create the block in.
+    # @param id [String, nil] Opaque block ID. Omit to let the server generate one. Block IDs are unique per ORGANIZATION (not per workflow) — reusing a human-friendly id like 'block_extract' across multiple workflows in the same org will fail with 409. Prefer the server-generated ``blk_<nanoid>`` form for predictability.
+    # @param type [Retab::Types::WorkflowBlockCreateRequestType] Block type
+    # @param label [String, nil] Display label
+    # @param position_x [Float, nil] X position
+    # @param position_y [Float, nil] Y position
+    # @param width [Float, nil] Block width
+    # @param height [Float, nil] Block height
+    # @param config [Hash{String => Object}, nil] Block configuration
+    # @param parent_id [String, nil] ID of parent container block (while_loop, for_each)
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowBlock]
+    def create(
+      workflow_id:,
+      type:,
+      id: nil,
+      label: nil,
+      position_x: nil,
+      position_y: nil,
+      width: nil,
+      height: nil,
+      config: nil,
+      parent_id: nil,
+      request_options: {}
+    )
+      body = {
+        'workflow_id' => workflow_id,
+        'id' => id,
+        'type' => type,
+        'label' => label,
+        'position_x' => position_x,
+        'position_y' => position_y,
+        'width' => width,
+        'height' => height,
+        'config' => config,
+        'parent_id' => parent_id
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: '/v1/workflows/blocks',
+        auth: true,
+        body: body,
+        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] Optional disambiguator for legacy duplicate block IDs. Required only when the block id is not unique within the org — in that case the unqualified call returns 409 listing the colliding workflow_ids. Newly-created blocks use server-generated opaque IDs and never need this.
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowBlock]
+    def get(
+      block_id:,
+      workflow_id: nil,
+      request_options: {}
+    )
+      params = {
+        'workflow_id' => workflow_id
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/v1/workflows/blocks/#{Retab::Util.encode_path(block_id)}",
+        auth: true,
+        params: params,
+        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
+
+    # Update Block
+    # @param block_id [String]
+    # @param label [String, nil]
+    # @param position_x [Float, nil]
+    # @param position_y [Float, nil]
+    # @param width [Float, nil]
+    # @param height [Float, nil]
+    # @param config [Hash{String => Object}, nil]
+    # @param parent_id [String, nil]
+    # @param config_mode [Retab::Types::UpdateWorkflowBlockRequestConfigMode, nil] How to apply the ``config`` field. 'merge' (default) deep-merges the patch into the existing config with null-as-delete; 'replace' uses the patch as the full new config. Not persisted.
+    # @param workflow_id [String, nil] Optional disambiguator for legacy duplicate block IDs. See ``GET /blocks/{block_id}`` for the full rationale.
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowBlock]
+    def update(
+      block_id:,
+      label: nil,
+      position_x: nil,
+      position_y: nil,
+      width: nil,
+      height: nil,
+      config: nil,
+      parent_id: nil,
+      config_mode: nil,
+      workflow_id: nil,
+      request_options: {}
+    )
+      params = {
+        'workflow_id' => workflow_id
+      }.compact
+      body = {
+        'label' => label,
+        'position_x' => position_x,
+        'position_y' => position_y,
+        'width' => width,
+        'height' => height,
+        'config' => config,
+        'parent_id' => parent_id,
+        'config_mode' => config_mode
+      }.compact
+      response = @client.request(
+        method: :patch,
+        path: "/v1/workflows/blocks/#{Retab::Util.encode_path(block_id)}",
+        auth: true,
+        params: params,
+        body: body,
+        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
+
+    # Delete Block
+    # @param block_id [String]
+    # @param workflow_id [String, nil] Optional disambiguator for legacy duplicate block IDs. See ``GET /blocks/{block_id}`` for the full rationale.
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [void]
+    def delete(
+      block_id:,
+      workflow_id: nil,
+      request_options: {}
+    )
+      params = {
+        'workflow_id' => workflow_id
+      }.compact
+      response = @client.request(
+        method: :delete,
+        path: "/v1/workflows/blocks/#{Retab::Util.encode_path(block_id)}",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      nil
+    end
+  end
+end

data/lib/retab/workflow_edges/workflow_edge_create_request.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class WorkflowEdgeCreateRequest < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      workflow_id: :workflow_id,
+      id: :id,
+      source_block: :source_block,
+      target_block: :target_block,
+      source_handle: :source_handle,
+      target_handle: :target_handle
+    }.freeze
+
+    attr_accessor \
+      :workflow_id,
+      :id,
+      :source_block,
+      :target_block,
+      :source_handle,
+      :target_handle
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @workflow_id = hash[:workflow_id]
+      @id = hash[:id]
+      @source_block = hash[:source_block]
+      @target_block = hash[:target_block]
+      @source_handle = hash[:source_handle]
+      @target_handle = hash[:target_handle]
+    end
+  end
+end

data/lib/retab/workflow_edges/workflow_edge_doc.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class WorkflowEdgeDoc < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      id: :id,
+      workflow_id: :workflow_id,
+      source_block: :source_block,
+      target_block: :target_block,
+      source_handle: :source_handle,
+      target_handle: :target_handle,
+      updated_at: :updated_at
+    }.freeze
+
+    attr_accessor \
+      :id,
+      :workflow_id,
+      :source_block,
+      :target_block,
+      :source_handle,
+      :target_handle,
+      :updated_at
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @id = hash[:id]
+      @workflow_id = hash[:workflow_id]
+      @source_block = hash[:source_block]
+      @target_block = hash[:target_block]
+      @source_handle = hash[:source_handle]
+      @target_handle = hash[:target_handle]
+      @updated_at = hash[:updated_at]
+    end
+  end
+end

data/lib/retab/workflow_edges.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require 'json'
+
+module Retab
+  class WorkflowEdges
+    def initialize(client)
+      @client = client
+    end
+
+    # List Edges
+    # @param workflow_id [String]
+    # @param source_block [String, nil] Filter by source block ID
+    # @param target_block [String, nil] Filter by target block ID
+    # @param before [String, nil] Edge id cursor: return the page before this id (mutually exclusive with ``after``).
+    # @param after [String, nil] Edge id cursor: return the page after this id (mutually exclusive with ``before``).
+    # @param limit [Integer, nil] Maximum number of edges to return per page (1-200).
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Types::ListStruct<Retab::WorkflowEdgeDoc>]
+    def list(
+      workflow_id:,
+      source_block: nil,
+      target_block: nil,
+      before: nil,
+      after: nil,
+      limit: 100,
+      request_options: {}
+    )
+      params = {
+        'workflow_id' => workflow_id,
+        'source_block' => source_block,
+        'target_block' => target_block,
+        'before' => before,
+        'after' => after,
+        'limit' => limit
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: '/v1/workflows/edges',
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = ->(cursor) {
+        list(
+          workflow_id: workflow_id,
+          source_block: source_block,
+          target_block: target_block,
+          before: before,
+          after: cursor,
+          limit: limit,
+          request_options: request_options
+        )
+      }
+      Retab::Types::ListStruct.from_response(
+        response,
+        model: Retab::WorkflowEdgeDoc,
+        filters: { workflow_id: workflow_id, source_block: source_block, target_block: target_block, before: before, limit: limit },
+        fetch_next: fetch_next
+      )
+    end
+
+    # Create Edge
+    # @param workflow_id [String] Workflow to create the edge in.
+    # @param id [String, nil] Opaque edge ID. Omit to let the server generate one.
+    # @param source_block [String] Source block ID
+    # @param target_block [String] Target block ID
+    # @param source_handle [String, nil] Output handle
+    # @param target_handle [String, nil] Input handle
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowEdgeDoc]
+    def create(
+      workflow_id:,
+      source_block:,
+      target_block:,
+      id: nil,
+      source_handle: nil,
+      target_handle: nil,
+      request_options: {}
+    )
+      body = {
+        'workflow_id' => workflow_id,
+        'id' => id,
+        'source_block' => source_block,
+        'target_block' => target_block,
+        'source_handle' => source_handle,
+        'target_handle' => target_handle
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: '/v1/workflows/edges',
+        auth: true,
+        body: body,
+        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)
+    # @return [Retab::WorkflowEdgeDoc]
+    def get(
+      edge_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/workflows/edges/#{Retab::Util.encode_path(edge_id)}",
+        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
+
+    # Delete Edge
+    # @param edge_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [void]
+    def delete(
+      edge_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :delete,
+        path: "/v1/workflows/edges/#{Retab::Util.encode_path(edge_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      nil
+    end
+  end
+end

data/lib/retab/workflow_experiments/create_experiment_request.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class CreateExperimentRequest < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      workflow_id: :workflow_id,
+      block_id: :block_id,
+      document_captures: :document_captures,
+      documents: :documents,
+      n_consensus: :n_consensus,
+      name: :name,
+      source_experiment_id: :source_experiment_id
+    }.freeze
+
+    attr_accessor \
+      :workflow_id,
+      :block_id,
+      :document_captures,
+      :documents,
+      :n_consensus,
+      :name,
+      :source_experiment_id
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @workflow_id = hash[:workflow_id]
+      @block_id = hash[:block_id]
+      @document_captures = (hash[:document_captures] || []).map { |item| item ? Retab::ExperimentDocumentCaptureRequest.new(item) : nil }
+      @documents = (hash[:documents] || []).map { |item| item ? Retab::ExplicitExperimentDocumentRequest.new(item) : nil }
+      @n_consensus = hash[:n_consensus]
+      @name = hash[:name]
+      @source_experiment_id = hash[:source_experiment_id]
+    end
+  end
+end