retab 0.1.0 → 0.1.1

data/lib/retab/edit_templates.rb

@@ -2,7 +2,7 @@
 
 # This file is auto-generated by oagen. Do not edit.
 
-require 'json'
+require "json"
 
 module Retab
   class EditTemplates
@@ -18,32 +18,32 @@ module Retab
     # @param name [String, nil]
     # @param sort_by [String, nil]
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
-    # @return [Retab::Types::ListStruct<Retab::EditTemplate>]
+    # @return [Retab::PaginatedList<Retab::EditTemplate>]
     def list(
       before: nil,
       after: nil,
       limit: 10,
-      order: 'desc',
+      order: "desc",
       name: nil,
-      sort_by: 'created_at',
+      sort_by: "created_at",
       request_options: {}
     )
       params = {
-        'before' => before,
-        'after' => after,
-        'limit' => limit,
-        'order' => order,
-        'name' => name,
-        'sort_by' => sort_by
+        "before" => before,
+        "after" => after,
+        "limit" => limit,
+        "order" => order,
+        "name" => name,
+        "sort_by" => sort_by
       }.compact
       response = @client.request(
         method: :get,
-        path: '/v1/edits/templates',
+        path: "/v1/edits/templates",
         auth: true,
         params: params,
         request_options: request_options
       )
-      fetch_next = ->(cursor) {
+      fetch_next = -> (cursor) {
         list(
           before: before,
           after: cursor,
@@ -54,10 +54,10 @@ module Retab
           request_options: request_options
         )
       }
-      Retab::Types::ListStruct.from_response(
+      Retab::PaginatedList.from_response(
         response,
         model: Retab::EditTemplate,
-        filters: { before: before, limit: limit, order: order, name: name, sort_by: sort_by },
+        filters: {before: before, limit: limit, order: order, name: name, sort_by: sort_by},
         fetch_next: fetch_next
       )
     end
@@ -76,19 +76,23 @@ module Retab
     )
       document = Retab::MimeData.coerce(document) unless document.nil?
       body = {
-        'name' => name,
-        'document' => document,
-        'form_fields' => form_fields
+        "name" => name,
+        "document" => document,
+        "form_fields" => form_fields
       }
       response = @client.request(
         method: :post,
-        path: '/v1/edits/templates',
+        path: "/v1/edits/templates",
         auth: true,
         body: body,
         request_options: request_options
       )
       result = Retab::EditTemplate.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.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
 
@@ -107,7 +111,11 @@ module Retab
         request_options: request_options
       )
       result = Retab::EditTemplate.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.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
 
@@ -124,8 +132,8 @@ module Retab
       request_options: {}
     )
       body = {
-        'name' => name,
-        'form_fields' => form_fields
+        "name" => name,
+        "form_fields" => form_fields
       }.compact
       response = @client.request(
         method: :patch,
@@ -135,7 +143,11 @@ module Retab
         request_options: request_options
       )
       result = Retab::EditTemplate.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.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
 
@@ -147,7 +159,7 @@ module Retab
       template_id:,
       request_options: {}
     )
-      response = @client.request(
+      @client.request(
         method: :delete,
         path: "/v1/edits/templates/#{Retab::Util.encode_path(template_id)}",
         auth: true,

data/lib/retab/edits/edit.rb

@@ -13,11 +13,12 @@ module Retab
       config: :config,
       template_id: :template_id,
       output: :output,
+      filled_document_ref: :filled_document_ref,
       usage: :usage,
       created_at: :created_at
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :id,
       :file,
       :model,
@@ -25,10 +26,13 @@ module Retab
       :config,
       :template_id,
       :output,
+      :filled_document_ref,
       :usage,
       :created_at
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @id = hash[:id]
       @file = hash[:file] ? Retab::FileRef.new(hash[:file]) : nil
@@ -37,6 +41,7 @@ module Retab
       @config = hash[:config] ? Retab::EditConfig.new(hash[:config]) : nil
       @template_id = hash[:template_id]
       @output = hash[:output] ? Retab::EditResult.new(hash[:output]) : nil
+      @filled_document_ref = hash[:filled_document_ref] ? Retab::FileRef.new(hash[:filled_document_ref]) : nil
       @usage = hash[:usage] ? Retab::RetabUsage.new(hash[:usage]) : nil
       @created_at = hash[:created_at]
     end

data/lib/retab/edits/edit_request.rb

@@ -14,15 +14,17 @@ module Retab
       bust_cache: :bust_cache
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :instructions,
       :document,
       :template_id,
       :model,
       :config,
       :bust_cache
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @instructions = hash[:instructions]
       @document = hash[:document] ? Retab::MimeData.new(hash[:document]) : nil

data/lib/retab/edits.rb

@@ -2,7 +2,7 @@
 
 # This file is auto-generated by oagen. Do not edit.
 
-require 'json'
+require "json"
 
 module Retab
   class Edits
@@ -10,6 +10,10 @@ module Retab
       @client = client
     end
 
+    def templates
+      @templates ||= Retab::EditTemplates.new(@client)
+    end
+
     # List Edits
     # @param before [String, nil]
     # @param after [String, nil]
@@ -20,12 +24,12 @@ module Retab
     # @param from_date [String, nil]
     # @param to_date [String, nil]
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
-    # @return [Retab::Types::ListStruct<Retab::Edit>]
+    # @return [Retab::PaginatedList<Retab::Edit>]
     def list(
       before: nil,
       after: nil,
       limit: 10,
-      order: 'desc',
+      order: "desc",
       filename: nil,
       template_id: nil,
       from_date: nil,
@@ -33,23 +37,23 @@ module Retab
       request_options: {}
     )
       params = {
-        'before' => before,
-        'after' => after,
-        'limit' => limit,
-        'order' => order,
-        'filename' => filename,
-        'template_id' => template_id,
-        'from_date' => from_date,
-        'to_date' => to_date
+        "before" => before,
+        "after" => after,
+        "limit" => limit,
+        "order" => order,
+        "filename" => filename,
+        "template_id" => template_id,
+        "from_date" => from_date,
+        "to_date" => to_date
       }.compact
       response = @client.request(
         method: :get,
-        path: '/v1/edits',
+        path: "/v1/edits",
         auth: true,
         params: params,
         request_options: request_options
       )
-      fetch_next = ->(cursor) {
+      fetch_next = -> (cursor) {
         list(
           before: before,
           after: cursor,
@@ -62,10 +66,18 @@ module Retab
           request_options: request_options
         )
       }
-      Retab::Types::ListStruct.from_response(
+      Retab::PaginatedList.from_response(
         response,
         model: Retab::Edit,
-        filters: { before: before, limit: limit, order: order, filename: filename, template_id: template_id, from_date: from_date, to_date: to_date },
+        filters: {
+          before: before,
+          limit: limit,
+          order: order,
+          filename: filename,
+          template_id: template_id,
+          from_date: from_date,
+          to_date: to_date
+        },
         fetch_next: fetch_next
       )
     end
@@ -90,22 +102,26 @@ module Retab
     )
       document = Retab::MimeData.coerce(document) unless document.nil?
       body = {
-        'instructions' => instructions,
-        'document' => document,
-        'template_id' => template_id,
-        'model' => model,
-        'config' => config,
-        'bust_cache' => bust_cache
+        "instructions" => instructions,
+        "document" => document,
+        "template_id" => template_id,
+        "model" => model,
+        "config" => config,
+        "bust_cache" => bust_cache
       }.compact
       response = @client.request(
         method: :post,
-        path: '/v1/edits',
+        path: "/v1/edits",
         auth: true,
         body: body,
         request_options: request_options
       )
       result = Retab::Edit.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.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
 
@@ -124,7 +140,11 @@ module Retab
         request_options: request_options
       )
       result = Retab::Edit.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.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
 
@@ -136,7 +156,7 @@ module Retab
       edit_id:,
       request_options: {}
     )
-      response = @client.request(
+      @client.request(
         method: :delete,
         path: "/v1/edits/#{Retab::Util.encode_path(edit_id)}",
         auth: true,

data/lib/retab/errors.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 
+# This file is auto-generated by oagen. Do not edit.
+
 # @oagen-ignore-file
 #
-# Hand-maintained error hierarchy. Mirrors what the WorkOS Ruby SDK ships;
-# the spec-driven resources reference these class names directly.
+# Hand-maintained error hierarchy. The spec-driven resources reference
+# these class names directly when mapping HTTP status to exceptions.
 
 module Retab
   class Error < StandardError
     attr_reader :http_status, :request_id, :code, :message_body
 
-    def initialize(message: nil, http_status: nil, request_id: nil, code: nil, body: nil)
-      super(message)
+    # Accept both calling conventions:
+    #   - positional: `raise Klass, "msg"` → `Klass.new("msg")` (Ruby's
+    #     built-in re-raise pattern and what `rescue => e; raise OtherKlass,
+    #     e.message` produces).
+    #   - keyword:    `raise Klass.new(message: 'x', http_status: 401)` —
+    #     used by `BaseClient#raise_for_status` to attach HTTP context.
+    def initialize(positional_message = nil, message: nil, http_status: nil, request_id: nil, code: nil, body: nil)
+      super(positional_message || message)
       @http_status = http_status
       @request_id = request_id
       @code = code
@@ -51,4 +59,13 @@ module Retab
 
   class ConfigurationError < Error
   end
+
+  # Raised when the SDK cannot reach the API host at all — DNS failure,
+  # TCP RST, host unreachable, etc. Distinct from `TimeoutError` (which is
+  # raised after a connection was successfully opened but read/write didn't
+  # complete in time) and from any 4xx/5xx `APIError` (which means the
+  # server WAS reached and replied with a status). Lets callers tell
+  # "your network is down" apart from "your input was invalid."
+  class ConnectionError < Error
+  end
 end

data/lib/retab/experiment_run_metrics/experiment_by_document_metrics_response.rb

@@ -16,7 +16,7 @@ module Retab
       targets: :targets
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :run_id,
       :kind,
       :view,
@@ -25,8 +25,10 @@ module Retab
       :prior_score,
       :confusion,
       :targets
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @run_id = hash[:run_id]
       @kind = hash[:kind]

data/lib/retab/experiment_run_metrics/experiment_by_document_target_metric.rb

@@ -12,13 +12,15 @@ module Retab
       value: :value
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :path,
       :score,
       :prior_score,
       :value
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @path = hash[:path]
       @score = hash[:score]

data/lib/retab/experiment_run_metrics/experiment_by_target_document_metric.rb

@@ -13,14 +13,16 @@ module Retab
       value: :value
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :id,
       :filename,
       :score,
       :prior_score,
       :value
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @id = hash[:id]
       @filename = hash[:filename]

data/lib/retab/experiment_run_metrics/experiment_by_target_metrics_response.rb

@@ -16,7 +16,7 @@ module Retab
       documents: :documents
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :run_id,
       :kind,
       :view,
@@ -25,8 +25,10 @@ module Retab
       :prior_score,
       :confusion,
       :documents
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @run_id = hash[:run_id]
       @kind = hash[:kind]
@@ -35,7 +37,9 @@ module Retab
       @score = hash[:score]
       @prior_score = hash[:prior_score]
       @confusion = hash[:confusion] ? Retab::ExperimentTargetConfusionMetric.new(hash[:confusion]) : nil
-      @documents = (hash[:documents] || []).map { |item| item ? Retab::ExperimentByTargetDocumentMetric.new(item) : nil }
+      @documents = (hash[:documents] || []).map { |item|
+        item ? Retab::ExperimentByTargetDocumentMetric.new(item) : nil
+      }
     end
   end
 end

data/lib/retab/experiment_run_metrics/experiment_confusion_flow_metric.rb

@@ -11,12 +11,14 @@ module Retab
       score: :score
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :source,
       :target,
       :score
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @source = hash[:source]
       @target = hash[:target]

data/lib/retab/experiment_run_metrics/experiment_confusion_summary_aggregate.rb

@@ -10,11 +10,13 @@ module Retab
       flows: :flows
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :diag,
       :flows
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @diag = hash[:diag] || {}
       @flows = (hash[:flows] || []).map { |item| item ? Retab::ExperimentConfusionFlowMetric.new(item) : nil }

data/lib/retab/experiment_run_metrics/experiment_extract_summary_aggregate.rb

@@ -12,6 +12,7 @@ module Retab
     attr_accessor :likelihoods
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @likelihoods = hash[:likelihoods] || {}
     end

data/lib/retab/experiment_run_metrics/experiment_metric_document_ref.rb

@@ -10,11 +10,13 @@ module Retab
       filename: :filename
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :id,
       :filename
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @id = hash[:id]
       @filename = hash[:filename]

data/lib/retab/experiment_run_metrics/experiment_metrics_missing_error.rb

@@ -12,13 +12,15 @@ module Retab
       message: :message
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :kind,
       :error,
       :experiment_id,
       :message
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @kind = hash[:kind]
       @error = hash[:error]

data/lib/retab/experiment_run_metrics/experiment_metrics_stale_error.rb

@@ -15,7 +15,7 @@ module Retab
       message: :message
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :kind,
       :error,
       :experiment_id,
@@ -23,8 +23,10 @@ module Retab
       :last_run,
       :current_config_fingerprint,
       :message
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @kind = hash[:kind]
       @error = hash[:error]

data/lib/retab/experiment_run_metrics/experiment_summary_metric_document.rb

@@ -12,13 +12,15 @@ module Retab
       prior_score: :prior_score
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :id,
       :filename,
       :score,
       :prior_score
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @id = hash[:id]
       @filename = hash[:filename]

data/lib/retab/experiment_run_metrics/experiment_summary_metrics_response.rb

@@ -19,7 +19,7 @@ module Retab
       prior_run_id: :prior_run_id
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :experiment_id,
       :run_id,
       :kind,
@@ -31,8 +31,10 @@ module Retab
       :documents,
       :aggregate,
       :prior_run_id
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @experiment_id = hash[:experiment_id]
       @run_id = hash[:run_id]
@@ -42,7 +44,9 @@ module Retab
       @block_type = hash[:block_type]
       @score = hash[:score]
       @prior_score = hash[:prior_score]
-      @documents = (hash[:documents] || []).map { |item| item ? Retab::ExperimentSummaryMetricDocument.new(item) : nil }
+      @documents = (hash[:documents] || []).map { |item|
+        item ? Retab::ExperimentSummaryMetricDocument.new(item) : nil
+      }
       @aggregate = hash[:aggregate] ? Retab::ExperimentExtractSummaryAggregate.new(hash[:aggregate]) : nil
       @prior_run_id = hash[:prior_run_id]
     end

data/lib/retab/experiment_run_metrics/experiment_target_confusion_metric.rb

@@ -11,12 +11,14 @@ module Retab
       flow_to: :flow_to
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :self,
       :flow_from,
       :flow_to
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @self = hash[:self]
       @flow_from = hash[:flow_from] || {}

data/lib/retab/experiment_run_metrics/experiment_vote_row.rb

@@ -14,15 +14,17 @@ module Retab
       total_voter_count: :total_voter_count
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :consensus,
       :votes,
       :score,
       :row_presence_score,
       :present_voter_count,
       :total_voter_count
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @consensus = hash[:consensus]
       @votes = (hash[:votes] || [])

data/lib/retab/experiment_run_metrics/experiment_votes_metrics_response.rb

@@ -16,7 +16,7 @@ module Retab
       rows: :rows
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :run_id,
       :kind,
       :view,
@@ -25,8 +25,10 @@ module Retab
       :score,
       :prior_score,
       :rows
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @run_id = hash[:run_id]
       @kind = hash[:kind]