retab 0.1.10 → 0.1.11

data/lib/retab/usage.rb

@@ -0,0 +1,267 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require "json"
+
+module Retab
+  class Usage
+    def initialize(client)
+      @client = client
+    end
+
+    # List Usage Blocks
+    # @param limit [Integer, nil] Maximum number of block rows to return.
+    # @param order [Retab::Types::UsageOrder, nil] Sort direction on block id.
+    # @param before [String, nil] Return blocks before this cursor (opaque token from a prior page's list_metadata).
+    # @param after [String, nil] Return blocks after this cursor (opaque token from a prior page's list_metadata).
+    # @param workflow_id [String, nil] Filter to a single workflow id.
+    # @param block_type [String, nil] Filter by block type (e.g. extract, classify, split, parse, edit, partition).
+    # @param from_date [String, nil] Inclusive activity lower bound (YYYY-MM-DD, UTC).
+    # @param to_date [String, nil] Inclusive activity upper bound (YYYY-MM-DD, UTC).
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::PaginatedList<Retab::UsageBlockRecord>]
+    def list_blocks(
+      limit: 20,
+      order: "desc",
+      before: nil,
+      after: nil,
+      workflow_id: nil,
+      block_type: nil,
+      from_date: nil,
+      to_date: nil,
+      request_options: {}
+    )
+      params = {
+        "limit" => limit,
+        "order" => order,
+        "before" => before,
+        "after" => after,
+        "workflow_id" => workflow_id,
+        "block_type" => block_type,
+        "from_date" => from_date,
+        "to_date" => to_date
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/v1/usage/blocks",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = -> (cursor) {
+        list_blocks(
+          limit: limit,
+          order: order,
+          before: before,
+          after: cursor,
+          workflow_id: workflow_id,
+          block_type: block_type,
+          from_date: from_date,
+          to_date: to_date,
+          request_options: request_options
+        )
+      }
+      Retab::PaginatedList.from_response(
+        response,
+        model: Retab::UsageBlockRecord,
+        filters: {
+          limit: limit,
+          order: order,
+          before: before,
+          workflow_id: workflow_id,
+          block_type: block_type,
+          from_date: from_date,
+          to_date: to_date
+        },
+        fetch_next: fetch_next
+      )
+    end
+
+    # List Usage Primitives
+    # @param limit [Integer, nil] Maximum number of execution rows to return.
+    # @param order [Retab::Types::UsageOrder, nil] Sort direction on execution created_at.
+    # @param before [String, nil] Return executions before this primitive-execution id (keyset cursor).
+    # @param after [String, nil] Return executions after this primitive-execution id (keyset cursor).
+    # @param environment_id [String, nil] Scope the export to this environment id within the caller's organization. Defaults to the authenticated identity's environment.
+    # @param workflow_id [String, nil] Filter to a single workflow id (origin workflow).
+    # @param project_id [String, nil] Filter to executions owned by a single project id.
+    # @param api_key_id [String, nil] Filter to executions triggered by a single API key id (the api_key_id returned under triggered_by).
+    # @param access_token_id [String, nil] Filter to executions triggered by a single access token id (the access_token_id returned under triggered_by).
+    # @param user_id [String, nil] Filter to executions triggered by a single user id (the user_id returned under triggered_by).
+    # @param run_id [String, nil] Filter to a single workflow run id (origin run).
+    # @param block_id [String, nil] Filter to a single workflow block id (origin block).
+    # @param operation [String, nil] Filter by operation (extraction, classify, split, parse, edit, schema_generation).
+    # @param status [String, nil] Filter by execution lifecycle status.
+    # @param metadata [String, nil] Filter by metadata equality: a JSON object of string key/value pairs (e.g. {"tenant":"acme"}). Pairs AND together.
+    # @param from_date [String, nil] Inclusive created_at lower bound (YYYY-MM-DD, UTC).
+    # @param to_date [String, nil] Inclusive created_at upper bound (YYYY-MM-DD, UTC).
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::PaginatedList<Retab::UsagePrimitiveRecord>]
+    def list_primitives(
+      limit: 20,
+      order: "desc",
+      before: nil,
+      after: nil,
+      environment_id: nil,
+      workflow_id: nil,
+      project_id: nil,
+      api_key_id: nil,
+      access_token_id: nil,
+      user_id: nil,
+      run_id: nil,
+      block_id: nil,
+      operation: nil,
+      status: nil,
+      metadata: nil,
+      from_date: nil,
+      to_date: nil,
+      request_options: {}
+    )
+      params = {
+        "limit" => limit,
+        "order" => order,
+        "before" => before,
+        "after" => after,
+        "environment_id" => environment_id,
+        "workflow_id" => workflow_id,
+        "project_id" => project_id,
+        "api_key_id" => api_key_id,
+        "access_token_id" => access_token_id,
+        "user_id" => user_id,
+        "run_id" => run_id,
+        "block_id" => block_id,
+        "operation" => operation,
+        "status" => status,
+        "metadata" => metadata,
+        "from_date" => from_date,
+        "to_date" => to_date
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/v1/usage/primitives",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = -> (cursor) {
+        list_primitives(
+          limit: limit,
+          order: order,
+          before: before,
+          after: cursor,
+          environment_id: environment_id,
+          workflow_id: workflow_id,
+          project_id: project_id,
+          api_key_id: api_key_id,
+          access_token_id: access_token_id,
+          user_id: user_id,
+          run_id: run_id,
+          block_id: block_id,
+          operation: operation,
+          status: status,
+          metadata: metadata,
+          from_date: from_date,
+          to_date: to_date,
+          request_options: request_options
+        )
+      }
+      Retab::PaginatedList.from_response(
+        response,
+        model: Retab::UsagePrimitiveRecord,
+        filters: {
+          limit: limit,
+          order: order,
+          before: before,
+          environment_id: environment_id,
+          workflow_id: workflow_id,
+          project_id: project_id,
+          api_key_id: api_key_id,
+          access_token_id: access_token_id,
+          user_id: user_id,
+          run_id: run_id,
+          block_id: block_id,
+          operation: operation,
+          status: status,
+          metadata: metadata,
+          from_date: from_date,
+          to_date: to_date
+        },
+        fetch_next: fetch_next
+      )
+    end
+
+    # List Usage Runs
+    # @param limit [Integer, nil] Maximum number of run rows to return.
+    # @param order [Retab::Types::UsageOrder, nil] Sort direction on run created_at.
+    # @param before [String, nil] Return runs before this run id (keyset cursor).
+    # @param after [String, nil] Return runs after this run id (keyset cursor).
+    # @param workflow_id [String, nil] Filter to a single workflow id.
+    # @param status [String, nil] Filter by lifecycle status: pending, queued, running, completed, error, failed, awaiting_review, or cancelled.
+    # @param trigger_type [String, nil] Filter by trigger type: manual, api, schedule, webhook, email, or restart.
+    # @param from_date [String, nil] Inclusive created_at lower bound (YYYY-MM-DD, UTC).
+    # @param to_date [String, nil] Inclusive created_at upper bound (YYYY-MM-DD, UTC).
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::PaginatedList<Retab::UsageRunRecord>]
+    def list_runs(
+      limit: 20,
+      order: "desc",
+      before: nil,
+      after: nil,
+      workflow_id: nil,
+      status: nil,
+      trigger_type: nil,
+      from_date: nil,
+      to_date: nil,
+      request_options: {}
+    )
+      params = {
+        "limit" => limit,
+        "order" => order,
+        "before" => before,
+        "after" => after,
+        "workflow_id" => workflow_id,
+        "status" => status,
+        "trigger_type" => trigger_type,
+        "from_date" => from_date,
+        "to_date" => to_date
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/v1/usage/runs",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = -> (cursor) {
+        list_runs(
+          limit: limit,
+          order: order,
+          before: before,
+          after: cursor,
+          workflow_id: workflow_id,
+          status: status,
+          trigger_type: trigger_type,
+          from_date: from_date,
+          to_date: to_date,
+          request_options: request_options
+        )
+      }
+      Retab::PaginatedList.from_response(
+        response,
+        model: Retab::UsageRunRecord,
+        filters: {
+          limit: limit,
+          order: order,
+          before: before,
+          workflow_id: workflow_id,
+          status: status,
+          trigger_type: trigger_type,
+          from_date: from_date,
+          to_date: to_date
+        },
+        fetch_next: fetch_next
+      )
+    end
+  end
+end

data/lib/retab/version.rb

@@ -5,5 +5,5 @@
 # @oagen-ignore-file
 
 module Retab
-  VERSION = "0.1.10"
+  VERSION = "0.1.11"
 end

data/lib/retab/workflow_experiments.rb

@@ -24,6 +24,7 @@ module Retab
 
     # List Experiments
     # @param workflow_id [String]
+    # @param block_id [String, nil]
     # @param before [String, nil]
     # @param after [String, nil]
     # @param limit [Integer, nil]
@@ -32,6 +33,7 @@ module Retab
     # @return [Retab::PaginatedList<Retab::WorkflowExperiment>]
     def list(
       workflow_id:,
+      block_id: nil,
       before: nil,
       after: nil,
       limit: 50,
@@ -40,6 +42,7 @@ module Retab
     )
       params = {
         "workflow_id" => workflow_id,
+        "block_id" => block_id,
         "before" => before,
         "after" => after,
         "limit" => limit,
@@ -55,6 +58,7 @@ module Retab
       fetch_next = -> (cursor) {
         list(
           workflow_id: workflow_id,
+          block_id: block_id,
           before: before,
           after: cursor,
           limit: limit,
@@ -65,7 +69,7 @@ module Retab
       Retab::PaginatedList.from_response(
         response,
         model: Retab::WorkflowExperiment,
-        filters: {workflow_id: workflow_id, before: before, limit: limit, order: order},
+        filters: {workflow_id: workflow_id, block_id: block_id, before: before, limit: limit, order: order},
         fetch_next: fetch_next
       )
     end

data/lib/retab/workflow_reviews/review.rb

@@ -67,8 +67,6 @@ module Retab
           Retab::ReviewCategoryIn.new(hash[:triggered_by])
         when "confidence_lt"
           Retab::ReviewConfidenceLt.new(hash[:triggered_by])
-        when "field_confidence_lt"
-          Retab::ReviewFieldConfidenceLt.new(hash[:triggered_by])
         when "json_condition"
           Retab::ReviewJsonCondition.new(hash[:triggered_by])
         when "split_count_neq"

data/lib/retab/workflow_reviews/review_all_of.rb

@@ -40,8 +40,6 @@ module Retab
             Retab::ReviewCategoryIn.new(item)
           when "confidence_lt"
             Retab::ReviewConfidenceLt.new(item)
-          when "field_confidence_lt"
-            Retab::ReviewFieldConfidenceLt.new(item)
           when "json_condition"
             Retab::ReviewJsonCondition.new(item)
           when "split_count_neq"

data/lib/retab/workflow_reviews/review_any_of.rb

@@ -40,8 +40,6 @@ module Retab
             Retab::ReviewCategoryIn.new(item)
           when "confidence_lt"
             Retab::ReviewConfidenceLt.new(item)
-          when "field_confidence_lt"
-            Retab::ReviewFieldConfidenceLt.new(item)
           when "json_condition"
             Retab::ReviewJsonCondition.new(item)
           when "split_count_neq"

data/lib/retab/workflow_runs/create_workflow_run_request.rb

@@ -9,14 +9,16 @@ module Retab
       workflow_id: :workflow_id,
       documents: :documents,
       json_inputs: :json_inputs,
-      version: :version
+      version: :version,
+      metadata: :metadata
     }.freeze
 
     attr_accessor(
       :workflow_id,
       :documents,
       :json_inputs,
-      :version
+      :version,
+      :metadata
     )
 
     def initialize(json)
@@ -26,6 +28,7 @@ module Retab
       @documents = hash[:documents] || {}
       @json_inputs = hash[:json_inputs] || {}
       @version = hash[:version].nil? ? "production" : hash[:version]
+      @metadata = hash[:metadata] || {}
     end
   end
 end

data/lib/retab/workflow_runs/workflow_run.rb

@@ -12,7 +12,8 @@ module Retab
       trigger: :trigger,
       lifecycle: :lifecycle,
       timing: :timing,
-      inputs: :inputs
+      inputs: :inputs,
+      metadata: :metadata
     }.freeze
 
     attr_accessor(
@@ -22,7 +23,8 @@ module Retab
       :trigger,
       :lifecycle,
       :timing,
-      :inputs
+      :inputs,
+      :metadata
     )
 
     def initialize(json)
@@ -52,6 +54,7 @@ module Retab
       ) : nil
       @timing = hash[:timing] ? Retab::RunTiming.new(hash[:timing]) : nil
       @inputs = hash[:inputs] ? Retab::RunInputs.new(hash[:inputs]) : nil
+      @metadata = hash[:metadata] || {}
     end
   end
 end

data/lib/retab/workflow_runs.rb

@@ -20,6 +20,7 @@ module Retab
     # @param min_duration_ms [Integer, nil] Filter runs with duration >= this value in milliseconds
     # @param max_duration_ms [Integer, nil] Filter runs with duration <= this value in milliseconds
     # @param search [String, nil] Search by run ID (partial match)
+    # @param metadata [String, nil] Filter by metadata equality: a JSON object of key/value pairs (e.g. {"tenant":"acme"}). Pairs AND together.
     # @param before [String, nil]
     # @param after [String, nil]
     # @param limit [Integer, nil] Items per page
@@ -37,6 +38,7 @@ module Retab
       min_duration_ms: nil,
       max_duration_ms: nil,
       search: nil,
+      metadata: nil,
       before: nil,
       after: nil,
       limit: 20,
@@ -54,6 +56,7 @@ module Retab
         "min_duration_ms" => min_duration_ms,
         "max_duration_ms" => max_duration_ms,
         "search" => search,
+        "metadata" => metadata,
         "before" => before,
         "after" => after,
         "limit" => limit,
@@ -78,6 +81,7 @@ module Retab
           min_duration_ms: min_duration_ms,
           max_duration_ms: max_duration_ms,
           search: search,
+          metadata: metadata,
           before: before,
           after: cursor,
           limit: limit,
@@ -99,6 +103,7 @@ module Retab
           min_duration_ms: min_duration_ms,
           max_duration_ms: max_duration_ms,
           search: search,
+          metadata: metadata,
           before: before,
           limit: limit,
           order: order,
@@ -113,6 +118,7 @@ module Retab
     # @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.
     # @param version [String, nil] Workflow version to run: 'production', 'draft', or a pinned version id like 'ver_...'. Only valid for fresh-run creation.
+    # @param metadata [Hash{String => String}, nil] User-defined metadata to associate with this workflow run.
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
     # @return [Retab::WorkflowRun]
     def create(
@@ -120,6 +126,7 @@ module Retab
       documents: nil,
       json_inputs: nil,
       version: nil,
+      metadata: nil,
       request_options: {}
     )
       documents = Retab::MimeData.coerce_document_map(documents, client: @client) unless documents.nil?
@@ -127,7 +134,8 @@ module Retab
         "workflow_id" => workflow_id,
         "documents" => documents,
         "json_inputs" => json_inputs,
-        "version" => version
+        "version" => version,
+        "metadata" => metadata
       }.compact
       response = @client.request(
         method: :post,

data/lib/retab/workflow_steps.rb

@@ -12,6 +12,7 @@ module Retab
 
     # List Workflow Run Steps
     # @param run_id [String, nil] Optional workflow run ID filter.
+    # @param workflow_id [String, nil]
     # @param block_id [String, nil] Optional logical block ID filter.
     # @param step_id [String, nil] Optional step ID filter.
     # @param block_type [Array<String>, nil] Optional block type filter. Repeat the query parameter for multiple values.
@@ -23,6 +24,7 @@ module Retab
     # @return [Retab::PaginatedList<Retab::WorkflowRunStep>]
     def list(
       run_id: nil,
+      workflow_id: nil,
       block_id: nil,
       step_id: nil,
       block_type: nil,
@@ -34,6 +36,7 @@ module Retab
     )
       params = {
         "run_id" => run_id,
+        "workflow_id" => workflow_id,
         "block_id" => block_id,
         "step_id" => step_id,
         "block_type" => block_type,
@@ -52,6 +55,7 @@ module Retab
       fetch_next = -> (cursor) {
         list(
           run_id: run_id,
+          workflow_id: workflow_id,
           block_id: block_id,
           step_id: step_id,
           block_type: block_type,
@@ -67,6 +71,7 @@ module Retab
         model: Retab::WorkflowRunStep,
         filters: {
           run_id: run_id,
+          workflow_id: workflow_id,
           block_id: block_id,
           step_id: step_id,
           block_type: block_type,

data/lib/retab/workflows/workflow.rb

@@ -12,9 +12,7 @@ module Retab
       project_id: :project_id,
       published: :published,
       created_at: :created_at,
-      updated_at: :updated_at,
-      capabilities: :capabilities,
-      authz_status: :authz_status
+      updated_at: :updated_at
     }.freeze
 
     attr_accessor(
@@ -24,9 +22,7 @@ module Retab
       :project_id,
       :published,
       :created_at,
-      :updated_at,
-      :capabilities,
-      :authz_status
+      :updated_at
     )
 
     def initialize(json)
@@ -39,8 +35,6 @@ module Retab
       @published = hash[:published] ? Retab::WorkflowPublished.new(hash[:published]) : nil
       @created_at = hash[:created_at]
       @updated_at = hash[:updated_at]
-      @capabilities = (hash[:capabilities] || [])
-      @authz_status = hash[:authz_status]
     end
   end
 end

data/lib/retab.rb

@@ -25,6 +25,7 @@ loader.collapse("#{__dir__}/retab/secrets")
 loader.collapse("#{__dir__}/retab/shared")
 loader.collapse("#{__dir__}/retab/splits")
 loader.collapse("#{__dir__}/retab/tables")
+loader.collapse("#{__dir__}/retab/usage")
 loader.collapse("#{__dir__}/retab/workflow_artifacts")
 loader.collapse("#{__dir__}/retab/workflow_block_executions")
 loader.collapse("#{__dir__}/retab/workflow_blocks")

data/rbi/retab/client.rbi

@@ -36,6 +36,9 @@ module Retab
     sig { returns(Retab::Tables) }
     def tables; end
 
+    sig { returns(Retab::Usage) }
+    def usage; end
+
     sig { returns(Retab::Workflows) }
     def workflows; end
 

data/rbi/retab/create_workflow_run_request.rbi

@@ -33,6 +33,12 @@ module Retab
     sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
     def version=(value); end
 
+    sig { returns(T.nilable(T::Hash[String, String])) }
+    def metadata; end
+
+    sig { params(value: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String])) }
+    def metadata=(value); end
+
     sig { returns(T::Hash[Symbol, T.untyped]) }
     def to_h; end
 

data/rbi/retab/{review_field_confidence_lt.rbi → reconstruct_document_ref.rbi}

@@ -5,27 +5,27 @@
 # typed: strong
 
 module Retab
-  class ReviewFieldConfidenceLt
+  class ReconstructDocumentRef
     sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
     def initialize(json); end
 
-    sig { returns(T.nilable(String)) }
-    def kind; end
+    sig { returns(String) }
+    def filename; end
 
-    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
-    def kind=(value); end
+    sig { params(value: String).returns(String) }
+    def filename=(value); end
 
     sig { returns(String) }
-    def path; end
+    def id; end
 
     sig { params(value: String).returns(String) }
-    def path=(value); end
+    def id=(value); end
 
-    sig { returns(Float) }
-    def threshold; end
+    sig { returns(T.nilable(String)) }
+    def mime_type; end
 
-    sig { params(value: Float).returns(Float) }
-    def threshold=(value); end
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def mime_type=(value); end
 
     sig { returns(T::Hash[Symbol, T.untyped]) }
     def to_h; end

data/rbi/retab/reconstruct_enriched_row.rbi

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module Retab
+  class ReconstructEnrichedRow
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(T::Array[String]) }
+    def cells; end
+
+    sig { params(value: T::Array[String]).returns(T::Array[String]) }
+    def cells=(value); end
+
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_h; end
+
+    sig { params(args: T.untyped).returns(String) }
+    def to_json(*args); end
+  end
+end

data/rbi/retab/reconstruct_enriched_table.rbi

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module Retab
+  class ReconstructEnrichedTable
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(String) }
+    def csv; end
+
+    sig { params(value: String).returns(String) }
+    def csv=(value); end
+
+    sig { returns(T::Array[String]) }
+    def header; end
+
+    sig { params(value: T::Array[String]).returns(T::Array[String]) }
+    def header=(value); end
+
+    sig { returns(String) }
+    def label; end
+
+    sig { params(value: String).returns(String) }
+    def label=(value); end
+
+    sig { returns(T::Array[Retab::ReconstructEnrichedRow]) }
+    def rows; end
+
+    sig { params(value: T::Array[Retab::ReconstructEnrichedRow]).returns(T::Array[Retab::ReconstructEnrichedRow]) }
+    def rows=(value); end
+
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_h; end
+
+    sig { params(args: T.untyped).returns(String) }
+    def to_json(*args); end
+  end
+end