retab 0.1.0 → 0.1.1

data/lib/retab/workflow_runs/api_trigger.rb

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

data/lib/retab/workflow_runs/awaiting_review_run.rb

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

data/lib/retab/workflow_runs/cancel_workflow_request.rb

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

data/lib/retab/workflow_runs/cancel_workflow_response.rb

@@ -11,12 +11,14 @@ module Retab
       cancellation_status: :cancellation_status
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :run,
       :redis_available,
       :cancellation_status
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @run = hash[:run] ? Retab::WorkflowRun.new(hash[:run]) : nil
       @redis_available = hash[:redis_available]

data/lib/retab/workflow_runs/cancelled_terminal.rb

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

data/lib/retab/workflow_runs/create_workflow_run_request.rb

@@ -6,10 +6,26 @@ module Retab
   class CreateWorkflowRunRequest < Retab::Types::BaseModel
 
     HASH_ATTRS = {
+      workflow_id: :workflow_id,
+      documents: :documents,
+      json_inputs: :json_inputs,
+      version: :version
     }.freeze
 
+    attr_accessor(
+      :workflow_id,
+      :documents,
+      :json_inputs,
+      :version
+    )
+
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
+      @workflow_id = hash[:workflow_id]
+      @documents = hash[:documents] || {}
+      @json_inputs = hash[:json_inputs] || {}
+      @version = hash[:version]
     end
   end
 end

data/lib/retab/workflow_runs/email_trigger.rb

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

data/lib/retab/workflow_runs/error_details.rb

@@ -14,15 +14,17 @@ module Retab
       context: :context
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :message,
       :stack_trace,
       :block_id,
       :block_name,
       :error_code,
       :context
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @message = hash[:message]
       @stack_trace = hash[:stack_trace]

data/lib/retab/workflow_runs/error_terminal.rb

@@ -14,15 +14,17 @@ module Retab
       failing_step_id: :failing_step_id
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :status,
       :message,
       :stage,
       :category,
       :details,
       :failing_step_id
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @status = hash[:status]
       @message = hash[:message]

data/lib/retab/workflow_runs/manual_trigger.rb

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

data/lib/retab/workflow_runs/pending_run.rb

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

data/lib/retab/workflow_runs/restart_trigger.rb

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

data/lib/retab/workflow_runs/run_inputs.rb

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

data/lib/retab/workflow_runs/run_timing.rb

@@ -14,15 +14,17 @@ module Retab
       duration_ms: :duration_ms
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :created_at,
       :started_at,
       :completed_at,
       :review_waiting_started_at,
       :accumulated_review_waiting_ms,
       :duration_ms
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @created_at = hash[:created_at]
       @started_at = hash[:started_at]

data/lib/retab/workflow_runs/running_run.rb

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

data/lib/retab/workflow_runs/schedule_trigger.rb

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

data/lib/retab/workflow_runs/webhook_trigger.rb

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

data/lib/retab/workflow_runs/workflow_export_payload_request.rb

@@ -22,7 +22,7 @@ module Retab
       quote: :quote
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :workflow_id,
       :block_id,
       :export_source,
@@ -37,8 +37,10 @@ module Retab
       :delimiter,
       :line_delimiter,
       :quote
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @workflow_id = hash[:workflow_id]
       @block_id = hash[:block_id]

data/lib/retab/workflow_runs/workflow_export_payload_response.rb

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

data/lib/retab/workflow_runs/workflow_run.rb

@@ -14,20 +14,56 @@ module Retab
       inputs: :inputs
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :id,
       :workflow,
       :trigger,
       :lifecycle,
       :timing,
       :inputs
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @id = hash[:id]
       @workflow = hash[:workflow] ? Retab::WorkflowSnapshotRef.new(hash[:workflow]) : nil
-      @trigger = hash[:trigger] ? (case hash[:trigger][:type] when "api" then Retab::ApiTrigger.new(hash[:trigger]) when "email" then Retab::EmailTrigger.new(hash[:trigger]) when "manual" then Retab::ManualTrigger.new(hash[:trigger]) when "restart" then Retab::RestartTrigger.new(hash[:trigger]) when "schedule" then Retab::ScheduleTrigger.new(hash[:trigger]) when "webhook" then Retab::WebhookTrigger.new(hash[:trigger]) else hash[:trigger] end) : nil
-      @lifecycle = hash[:lifecycle] ? (case hash[:lifecycle][:status] when "awaiting_review" then Retab::AwaitingReviewRun.new(hash[:lifecycle]) when "cancelled" then Retab::CancelledTerminal.new(hash[:lifecycle]) when "completed" then Retab::CompletedTerminal.new(hash[:lifecycle]) when "error" then Retab::ErrorTerminal.new(hash[:lifecycle]) when "pending" then Retab::PendingRun.new(hash[:lifecycle]) when "running" then Retab::RunningRun.new(hash[:lifecycle]) else hash[:lifecycle] end) : nil
+      @trigger = hash[:trigger] ? (
+        case hash[:trigger][:type]
+        when "api"
+          Retab::ApiTrigger.new(hash[:trigger])
+        when "email"
+          Retab::EmailTrigger.new(hash[:trigger])
+        when "manual"
+          Retab::ManualTrigger.new(hash[:trigger])
+        when "restart"
+          Retab::RestartTrigger.new(hash[:trigger])
+        when "schedule"
+          Retab::ScheduleTrigger.new(hash[:trigger])
+        when "webhook"
+          Retab::WebhookTrigger.new(hash[:trigger])
+        else
+          hash[:trigger]
+        end
+      ) : nil
+      @lifecycle = hash[:lifecycle] ? (
+        case hash[:lifecycle][:status]
+        when "awaiting_review"
+          Retab::AwaitingReviewRun.new(hash[:lifecycle])
+        when "cancelled"
+          Retab::CancelledTerminal.new(hash[:lifecycle])
+        when "completed"
+          Retab::CompletedTerminal.new(hash[:lifecycle])
+        when "error"
+          Retab::ErrorTerminal.new(hash[:lifecycle])
+        when "pending"
+          Retab::PendingRun.new(hash[:lifecycle])
+        when "running"
+          Retab::RunningRun.new(hash[:lifecycle])
+        else
+          hash[:lifecycle]
+        end
+      ) : nil
       @timing = hash[:timing] ? Retab::RunTiming.new(hash[:timing]) : nil
       @inputs = hash[:inputs] ? Retab::RunInputs.new(hash[:inputs]) : nil
     end

data/lib/retab/workflow_runs/workflow_snapshot_ref.rb

@@ -12,13 +12,15 @@ module Retab
       requested_version: :requested_version
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :workflow_id,
       :version_id,
       :name_at_run_time,
       :requested_version
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @workflow_id = hash[:workflow_id]
       @version_id = hash[:version_id]

data/lib/retab/workflow_runs.rb

@@ -2,7 +2,7 @@
 
 # This file is auto-generated by oagen. Do not edit.
 
-require 'json'
+require "json"
 
 module Retab
   class WorkflowRuns
@@ -28,7 +28,7 @@ module Retab
     # @param order [Retab::Types::WorkflowRunsOrder, nil]
     # @param sort_by [String, nil]
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
-    # @return [Retab::Types::ListStruct<Retab::WorkflowRun>]
+    # @return [Retab::PaginatedList<Retab::WorkflowRun>]
     def list(
       workflow_id: nil,
       status: nil,
@@ -44,36 +44,36 @@ module Retab
       before: nil,
       after: nil,
       limit: 20,
-      order: 'desc',
-      sort_by: 'timing.created_at',
+      order: "desc",
+      sort_by: "timing.created_at",
       request_options: {}
     )
       params = {
-        'workflow_id' => workflow_id,
-        'status' => status,
-        'statuses' => statuses,
-        'exclude_status' => exclude_status,
-        'trigger_type' => trigger_type,
-        'trigger_types' => trigger_types,
-        'from_date' => from_date,
-        'to_date' => to_date,
-        'min_duration_ms' => min_duration_ms,
-        'max_duration_ms' => max_duration_ms,
-        'search' => search,
-        'before' => before,
-        'after' => after,
-        'limit' => limit,
-        'order' => order,
-        'sort_by' => sort_by
+        "workflow_id" => workflow_id,
+        "status" => status,
+        "statuses" => statuses,
+        "exclude_status" => exclude_status,
+        "trigger_type" => trigger_type,
+        "trigger_types" => trigger_types,
+        "from_date" => from_date,
+        "to_date" => to_date,
+        "min_duration_ms" => min_duration_ms,
+        "max_duration_ms" => max_duration_ms,
+        "search" => search,
+        "before" => before,
+        "after" => after,
+        "limit" => limit,
+        "order" => order,
+        "sort_by" => sort_by
       }.compact
       response = @client.request(
         method: :get,
-        path: '/v1/workflows/runs',
+        path: "/v1/workflows/runs",
         auth: true,
         params: params,
         request_options: request_options
       )
-      fetch_next = ->(cursor) {
+      fetch_next = -> (cursor) {
         list(
           workflow_id: workflow_id,
           status: status,
@@ -94,26 +94,64 @@ module Retab
           request_options: request_options
         )
       }
-      Retab::Types::ListStruct.from_response(
+      Retab::PaginatedList.from_response(
         response,
         model: Retab::WorkflowRun,
-        filters: { workflow_id: workflow_id, status: status, statuses: statuses, exclude_status: exclude_status, trigger_type: trigger_type, trigger_types: trigger_types, from_date: from_date, to_date: to_date, min_duration_ms: min_duration_ms, max_duration_ms: max_duration_ms, search: search, before: before, limit: limit, order: order, sort_by: sort_by },
+        filters: {
+          workflow_id: workflow_id,
+          status: status,
+          statuses: statuses,
+          exclude_status: exclude_status,
+          trigger_type: trigger_type,
+          trigger_types: trigger_types,
+          from_date: from_date,
+          to_date: to_date,
+          min_duration_ms: min_duration_ms,
+          max_duration_ms: max_duration_ms,
+          search: search,
+          before: before,
+          limit: limit,
+          order: order,
+          sort_by: sort_by
+        },
         fetch_next: fetch_next
       )
     end
 
     # Create Workflow Run Route
+    # @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.
+    # @param version [String, nil] Workflow version to run: 'production', 'draft', or a pinned version id like 'ver_...'. Only valid for fresh-run creation.
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
     # @return [Retab::WorkflowRun]
-    def create(request_options: {})
+    def create(
+      workflow_id:,
+      documents: nil,
+      json_inputs: nil,
+      version: nil,
+      request_options: {}
+    )
+      documents = Retab::MimeData.coerce_document_map(documents) unless documents.nil?
+      body = {
+        "workflow_id" => workflow_id,
+        "documents" => documents,
+        "json_inputs" => json_inputs,
+        "version" => version
+      }.compact
       response = @client.request(
         method: :post,
-        path: '/v1/workflows/runs',
+        path: "/v1/workflows/runs",
         auth: true,
+        body: body,
         request_options: request_options
       )
       result = Retab::WorkflowRun.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
 
@@ -152,30 +190,34 @@ module Retab
       request_options: {}
     )
       body = {
-        'workflow_id' => workflow_id,
-        'block_id' => block_id,
-        'export_source' => export_source,
-        'selected_run_ids' => selected_run_ids,
-        'selected_doc_types' => selected_doc_types,
-        'status' => status,
-        'exclude_status' => exclude_status,
-        'from_date' => from_date,
-        'to_date' => to_date,
-        'trigger_types' => trigger_types,
-        'preferred_columns' => preferred_columns,
-        'delimiter' => delimiter,
-        'line_delimiter' => line_delimiter,
-        'quote' => quote
+        "workflow_id" => workflow_id,
+        "block_id" => block_id,
+        "export_source" => export_source,
+        "selected_run_ids" => selected_run_ids,
+        "selected_doc_types" => selected_doc_types,
+        "status" => status,
+        "exclude_status" => exclude_status,
+        "from_date" => from_date,
+        "to_date" => to_date,
+        "trigger_types" => trigger_types,
+        "preferred_columns" => preferred_columns,
+        "delimiter" => delimiter,
+        "line_delimiter" => line_delimiter,
+        "quote" => quote
       }.compact
       response = @client.request(
         method: :post,
-        path: '/v1/workflows/runs/export',
+        path: "/v1/workflows/runs/export",
         auth: true,
         body: body,
         request_options: request_options
       )
       result = Retab::WorkflowExportPayloadResponse.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
 
@@ -194,7 +236,11 @@ module Retab
         request_options: request_options
       )
       result = Retab::WorkflowRun.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
 
@@ -206,7 +252,7 @@ module Retab
       run_id:,
       request_options: {}
     )
-      response = @client.request(
+      @client.request(
         method: :delete,
         path: "/v1/workflows/runs/#{Retab::Util.encode_path(run_id)}",
         auth: true,
@@ -226,7 +272,7 @@ module Retab
       request_options: {}
     )
       body = {
-        'command_id' => command_id
+        "command_id" => command_id
       }.compact
       response = @client.request(
         method: :post,
@@ -236,7 +282,11 @@ module Retab
         request_options: request_options
       )
       result = Retab::CancelWorkflowResponse.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
   end

data/lib/retab/{workflow_specs → workflow_spec}/declarative_apply_response.rb

@@ -18,7 +18,7 @@ module Retab
       rendered_plan: :rendered_plan
     }.freeze
 
-    attr_accessor \
+    attr_accessor(
       :workflow_id,
       :action,
       :created,
@@ -29,8 +29,10 @@ module Retab
       :summary,
       :resource_changes,
       :rendered_plan
+    )
 
     def initialize(json)
+      super()
       hash = self.class.normalize(json)
       @workflow_id = hash[:workflow_id]
       @action = hash[:action]
@@ -40,7 +42,9 @@ module Retab
       @diagnostics = hash[:diagnostics] || {}
       @format_version = hash[:format_version]
       @summary = hash[:summary] ? Retab::DeclarativePlanSummary.new(hash[:summary]) : nil
-      @resource_changes = (hash[:resource_changes] || []).map { |item| item ? Retab::DeclarativePlanResourceChange.new(item) : nil }
+      @resource_changes = (hash[:resource_changes] || []).map { |item|
+        item ? Retab::DeclarativePlanResourceChange.new(item) : nil
+      }
       @rendered_plan = hash[:rendered_plan]
     end
   end

data/lib/retab/{workflow_specs → workflow_spec}/declarative_export_response.rb

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