retab 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d8f00bc26ed73aa5d559ff12a8903bc8e0902d16aa47ee5bacdc174face30ad
-  data.tar.gz: c152d02486ec700e26c0a59c1ff51e07f15567516bfd06e19899ce1619771e30
+  metadata.gz: 38b6a8e2e340f9d1cb96c2eceb39489eef534c6a0ab109c734825e5ac751560e
+  data.tar.gz: 5faa19319e8b1cc05d8c2ab87dc8cfa66fa5edfb263b57c838a856d3338eb333
 SHA512:
-  metadata.gz: b89d753a806f26903c1f1bd3c005a80f92d8b7d940eba048d6f78de16e5241a27a628505eb2c320144dc1eed41579eefd750488007a345ced2368d4e24dec5fa
-  data.tar.gz: 4472ad621a070d8e80e703f3f4f4740d212ff7481966ce3094cb082361f74c648a8f0712bd43a1c34997d91ed8205c5146149b614252b4b607124ab33dba6054
+  metadata.gz: 2f9939d87d73b00d4be259f23312fb4bd9d601a50da1c78eeefe9a1689348a30f5cde3ec4156898de756acefc2fb18b8a8c6c4268ac919cae69bd3b9e26c0dff
+  data.tar.gz: 516e8423c347567277dc9caabcf35e00001d35f73b04016fe6b4bbdaa82470ba66f7b1c21b18e957967e78d38112b5837a0dff2f5dca7daffe7af67484cd955b

data/lib/retab/client.rb

@@ -45,6 +45,10 @@ module Retab
       @tables ||= Retab::Tables.new(self)
     end
 
+    def usage
+      @usage ||= Retab::Usage.new(self)
+    end
+
     def workflows
       @workflows ||= Retab::Workflows.new(self)
     end

data/lib/retab/paginated_list.rb

@@ -5,7 +5,7 @@
 # @oagen-ignore-file
 #
 # Cross-language paginated-list wrapper. See
-# .notes/blueprints/sdk-pagination-contract.md for the full contract.
+# docs/blueprints/sdk-pagination-contract.md for the full contract.
 #
 # Every `def list` method on a Retab service returns one of these. The
 # class includes `Enumerable`, so callers can iterate every page

data/lib/retab/splits/reconstruct_document_ref.rb

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

data/lib/retab/splits/reconstruct_enriched_row.rb

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

data/lib/retab/splits/reconstruct_enriched_table.rb

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

data/lib/retab/splits/reconstruct_enrichment_options.rb

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

data/lib/retab/splits/reconstruct_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class ReconstructRequest < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      document: :document,
+      subdocuments: :subdocuments
+    }.freeze
+
+    attr_accessor(
+      :document,
+      :subdocuments
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @document = hash[:document] ? Retab::ReconstructDocumentRef.new(hash[:document]) : nil
+      @subdocuments = (hash[:subdocuments] || []).map { |item| item ? Retab::ReconstructSubdocument.new(item) : nil }
+    end
+  end
+end

data/lib/retab/splits/reconstruct_response.rb

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

data/lib/retab/splits/reconstruct_subdocument.rb

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

data/lib/retab/splits/sheet_region.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class SheetRegion < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      col_end: :col_end,
+      col_start: :col_start,
+      header_rows: :header_rows,
+      row_end: :row_end,
+      row_start: :row_start,
+      sheet_index: :sheet_index,
+      sheet_name: :sheet_name
+    }.freeze
+
+    attr_accessor(
+      :col_end,
+      :col_start,
+      :header_rows,
+      :row_end,
+      :row_start,
+      :sheet_index,
+      :sheet_name
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @col_end = hash[:col_end]
+      @col_start = hash[:col_start]
+      @header_rows = (hash[:header_rows] || [])
+      @row_end = hash[:row_end]
+      @row_start = hash[:row_start]
+      @sheet_index = hash[:sheet_index]
+      @sheet_name = hash[:sheet_name]
+    end
+  end
+end

data/lib/retab/splits/split_result.rb

@@ -7,12 +7,14 @@ module Retab
 
     HASH_ATTRS = {
       name: :name,
-      pages: :pages
+      pages: :pages,
+      regions: :regions
     }.freeze
 
     attr_accessor(
       :name,
-      :pages
+      :pages,
+      :regions
     )
 
     def initialize(json)
@@ -20,6 +22,7 @@ module Retab
       hash = self.class.normalize(json)
       @name = hash[:name]
       @pages = (hash[:pages] || [])
+      @regions = (hash[:regions] || []).map { |item| item ? Retab::SheetRegion.new(item) : nil }
     end
   end
 end

data/lib/retab/splits.rb

@@ -124,6 +124,36 @@ module Retab
       result
     end
 
+    # Reconstruct Split
+    # @param document [Retab::ReconstructDocumentRef]
+    # @param subdocuments [Array<Retab::ReconstructSubdocument>]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::ReconstructResponse]
+    def create_reconstruct(
+      document:,
+      subdocuments:,
+      request_options: {}
+    )
+      body = {
+        "document" => document,
+        "subdocuments" => subdocuments
+      }
+      response = @client.request(
+        method: :post,
+        path: "/v1/splits/reconstruct",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::ReconstructResponse.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 Split
     # @param split_id [String]
     # @param include_output [Boolean, nil] When false, returns a cheap status-only projection (no output), served from cache for in-flight background runs.

data/lib/retab/types/usage_order.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    UsageOrder = ClassificationsOrder
+  end
+end

data/lib/retab/usage/usage_block_record.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class UsageBlockRecord < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      block_id: :block_id,
+      block_type: :block_type,
+      credits: :credits,
+      execution_count: :execution_count,
+      first_activity_at: :first_activity_at,
+      last_activity_at: :last_activity_at,
+      page_count: :page_count,
+      run_count: :run_count,
+      status_counts: :status_counts,
+      workflow_id: :workflow_id
+    }.freeze
+
+    attr_accessor(
+      :block_id,
+      :block_type,
+      :credits,
+      :execution_count,
+      :first_activity_at,
+      :last_activity_at,
+      :page_count,
+      :run_count,
+      :status_counts,
+      :workflow_id
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @block_id = hash[:block_id]
+      @block_type = hash[:block_type]
+      @credits = hash[:credits]
+      @execution_count = hash[:execution_count]
+      @first_activity_at = hash[:first_activity_at]
+      @last_activity_at = hash[:last_activity_at]
+      @page_count = hash[:page_count]
+      @run_count = hash[:run_count]
+      @status_counts = hash[:status_counts] || {}
+      @workflow_id = hash[:workflow_id]
+    end
+  end
+end

data/lib/retab/usage/usage_primitive_document.rb

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

data/lib/retab/usage/usage_primitive_record.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class UsagePrimitiveRecord < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      block_id: :block_id,
+      completed_at: :completed_at,
+      created_at: :created_at,
+      credits: :credits,
+      documents: :documents,
+      duration_ms: :duration_ms,
+      environment_id: :environment_id,
+      metadata: :metadata,
+      model: :model,
+      operation: :operation,
+      page_count: :page_count,
+      primitive_execution_id: :primitive_execution_id,
+      project_id: :project_id,
+      resource_kind: :resource_kind,
+      run_id: :run_id,
+      status: :status,
+      triggered_by: :triggered_by,
+      workflow_id: :workflow_id
+    }.freeze
+
+    attr_accessor(
+      :block_id,
+      :completed_at,
+      :created_at,
+      :credits,
+      :documents,
+      :duration_ms,
+      :environment_id,
+      :metadata,
+      :model,
+      :operation,
+      :page_count,
+      :primitive_execution_id,
+      :project_id,
+      :resource_kind,
+      :run_id,
+      :status,
+      :triggered_by,
+      :workflow_id
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @block_id = hash[:block_id]
+      @completed_at = hash[:completed_at]
+      @created_at = hash[:created_at]
+      @credits = hash[:credits]
+      @documents = (hash[:documents] || []).map { |item| item ? Retab::UsagePrimitiveDocument.new(item) : nil }
+      @duration_ms = hash[:duration_ms]
+      @environment_id = hash[:environment_id]
+      @metadata = hash[:metadata] || {}
+      @model = hash[:model]
+      @operation = hash[:operation]
+      @page_count = hash[:page_count]
+      @primitive_execution_id = hash[:primitive_execution_id]
+      @project_id = hash[:project_id]
+      @resource_kind = hash[:resource_kind]
+      @run_id = hash[:run_id]
+      @status = hash[:status]
+      @triggered_by = hash[:triggered_by] ? Retab::UsagePrimitiveTriggeredBy.new(hash[:triggered_by]) : nil
+      @workflow_id = hash[:workflow_id]
+    end
+  end
+end

data/lib/retab/usage/usage_primitive_triggered_by.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class UsagePrimitiveTriggeredBy < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      access_token_id: :access_token_id,
+      api_key_id: :api_key_id,
+      auth_method: :auth_method,
+      key_name: :key_name,
+      key_prefix: :key_prefix,
+      user_id: :user_id
+    }.freeze
+
+    attr_accessor(
+      :access_token_id,
+      :api_key_id,
+      :auth_method,
+      :key_name,
+      :key_prefix,
+      :user_id
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @access_token_id = hash[:access_token_id]
+      @api_key_id = hash[:api_key_id]
+      @auth_method = hash[:auth_method]
+      @key_name = hash[:key_name]
+      @key_prefix = hash[:key_prefix]
+      @user_id = hash[:user_id]
+    end
+  end
+end

data/lib/retab/usage/usage_run_record.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class UsageRunRecord < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      completed_at: :completed_at,
+      created_at: :created_at,
+      credits: :credits,
+      duration_ms: :duration_ms,
+      execution_duration_ms: :execution_duration_ms,
+      page_count: :page_count,
+      retry_count: :retry_count,
+      run_id: :run_id,
+      started_at: :started_at,
+      status: :status,
+      trigger_type: :trigger_type,
+      workflow_id: :workflow_id
+    }.freeze
+
+    attr_accessor(
+      :completed_at,
+      :created_at,
+      :credits,
+      :duration_ms,
+      :execution_duration_ms,
+      :page_count,
+      :retry_count,
+      :run_id,
+      :started_at,
+      :status,
+      :trigger_type,
+      :workflow_id
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @completed_at = hash[:completed_at]
+      @created_at = hash[:created_at]
+      @credits = hash[:credits]
+      @duration_ms = hash[:duration_ms]
+      @execution_duration_ms = hash[:execution_duration_ms]
+      @page_count = hash[:page_count]
+      @retry_count = hash[:retry_count]
+      @run_id = hash[:run_id]
+      @started_at = hash[:started_at]
+      @status = hash[:status]
+      @trigger_type = hash[:trigger_type]
+      @workflow_id = hash[:workflow_id]
+    end
+  end
+end