retab 0.1.6 → 0.1.8

data/lib/retab/workflows.rb

@@ -52,6 +52,7 @@ module Retab
     # @param limit [Integer, nil] Items per page
     # @param order [Retab::Types::WorkflowsOrder, nil]
     # @param sort_by [String, nil]
+    # @param project_id [String, nil] Only return workflows belonging to this project. Use the shared project's id to list the organization's shared workflows.
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
     # @return [Retab::PaginatedList<Retab::Workflow>]
     def list(
@@ -60,6 +61,7 @@ module Retab
       limit: 10,
       order: "desc",
       sort_by: "updated_at",
+      project_id: nil,
       request_options: {}
     )
       params = {
@@ -67,7 +69,8 @@ module Retab
         "after" => after,
         "limit" => limit,
         "order" => order,
-        "sort_by" => sort_by
+        "sort_by" => sort_by,
+        "project_id" => project_id
       }.compact
       response = @client.request(
         method: :get,
@@ -83,13 +86,14 @@ module Retab
           limit: limit,
           order: order,
           sort_by: sort_by,
+          project_id: project_id,
           request_options: request_options
         )
       }
       Retab::PaginatedList.from_response(
         response,
         model: Retab::Workflow,
-        filters: {before: before, limit: limit, order: order, sort_by: sort_by},
+        filters: {before: before, limit: limit, order: order, sort_by: sort_by, project_id: project_id},
         fetch_next: fetch_next
       )
     end
@@ -97,16 +101,19 @@ module Retab
     # Create Workflow
     # @param name [String, nil] The name of the workflow
     # @param description [String, nil] Description of the workflow
+    # @param project_id [String] Project that should own this workflow.
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
     # @return [Retab::Workflow]
     def create(
+      project_id:,
       name: nil,
       description: nil,
       request_options: {}
     )
       body = {
         "name" => name,
-        "description" => description
+        "description" => description,
+        "project_id" => project_id
       }.compact
       response = @client.request(
         method: :post,
@@ -124,6 +131,205 @@ module Retab
       result
     end
 
+    # Apply Workflow Spec
+    # @param yaml_definition [String] Workflow YAML definition
+    # @param project_id [String, nil] Project that should own a workflow created from this spec. Required when applying a spec that creates a new workflow.
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::DeclarativeApplyResponse]
+    def apply(
+      yaml_definition:,
+      project_id: nil,
+      workflow_id: nil,
+      request_options: {}
+    )
+      path = workflow_id.nil? ? "/v1/workflows/spec/apply" : "/v1/workflows/#{Retab::Util.encode_path(workflow_id)}/spec/apply"
+      body = {
+        "yaml_definition" => yaml_definition,
+        "project_id" => project_id
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: path,
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::DeclarativeApplyResponse.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
+
+    # Plan Workflow Spec
+    # @param yaml_definition [String] Workflow YAML definition
+    # @param project_id [String, nil] Project that should own a workflow created from this spec. Required when applying a spec that creates a new workflow.
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::DeclarativePlanResponse]
+    def plan(
+      yaml_definition:,
+      project_id: nil,
+      workflow_id: nil,
+      request_options: {}
+    )
+      path = workflow_id.nil? ? "/v1/workflows/spec/plan" : "/v1/workflows/#{Retab::Util.encode_path(workflow_id)}/spec/plan"
+      body = {
+        "yaml_definition" => yaml_definition,
+        "project_id" => project_id
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: path,
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::DeclarativePlanResponse.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
+
+    # List Workflow Versions
+    # @param workflow_id [String] Workflow whose versions to list
+    # @param before [String, nil] Workflow version cursor before
+    # @param after [String, nil] Workflow version cursor after
+    # @param limit [Integer, nil] Maximum number of versions to return
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::PaginatedList<Retab::WorkflowGraphVersion>]
+    def list_versions(
+      workflow_id:,
+      before: nil,
+      after: nil,
+      limit: 50,
+      request_options: {}
+    )
+      params = {
+        "workflow_id" => workflow_id,
+        "before" => before,
+        "after" => after,
+        "limit" => limit
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/v1/workflows/versions",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = -> (cursor) {
+        list_versions(
+          workflow_id: workflow_id,
+          before: before,
+          after: cursor,
+          limit: limit,
+          request_options: request_options
+        )
+      }
+      Retab::PaginatedList.from_response(
+        response,
+        model: Retab::WorkflowGraphVersion,
+        filters: {workflow_id: workflow_id, before: before, limit: limit},
+        fetch_next: fetch_next
+      )
+    end
+
+    # Diff Workflow Versions
+    # @param workflow_id [String] Workflow whose versions to diff
+    # @param from_workflow_version_id [String] Base workflow version ID
+    # @param to_workflow_version_id [String] Target workflow version ID
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowGraphVersionDiff]
+    def list_diff(
+      workflow_id:,
+      from_workflow_version_id:,
+      to_workflow_version_id:,
+      request_options: {}
+    )
+      params = {
+        "workflow_id" => workflow_id,
+        "from_workflow_version_id" => from_workflow_version_id,
+        "to_workflow_version_id" => to_workflow_version_id
+      }
+      response = @client.request(
+        method: :get,
+        path: "/v1/workflows/versions/diff",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      result = Retab::WorkflowGraphVersionDiff.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 Workflow Version
+    # @param workflow_version_id [String]
+    # @param workflow_id [String] Workflow that owns the version. Workflow version ids are content-addressed by executable spec, so workflow_id disambiguates identical specs reused across workflows.
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowGraphVersion]
+    def get_version(
+      workflow_version_id:,
+      workflow_id:,
+      request_options: {}
+    )
+      params = {
+        "workflow_id" => workflow_id
+      }
+      response = @client.request(
+        method: :get,
+        path: "/v1/workflows/versions/#{Retab::Util.encode_path(workflow_version_id)}",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      result = Retab::WorkflowGraphVersion.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
+
+    # Restore Workflow Version
+    # @param workflow_version_id [String]
+    # @param workflow_id [String] Workflow to restore into a new draft
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Workflow]
+    def create_version_restore(
+      workflow_version_id:,
+      workflow_id:,
+      request_options: {}
+    )
+      params = {
+        "workflow_id" => workflow_id
+      }
+      response = @client.request(
+        method: :post,
+        path: "/v1/workflows/versions/#{Retab::Util.encode_path(workflow_version_id)}/restore",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      result = Retab::Workflow.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 Workflow
     # @param workflow_id [String]
     # @param request_options [Hash] (see Retab::Types::RequestOptions)

data/rbi/retab/artifact_drift.rbi

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module Retab
+  class ArtifactDrift
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(T.nilable(String)) }
+    def status; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def status=(value); end
+
+    sig { returns(T.nilable(T::Array[String])) }
+    def affected_targets; end
+
+    sig { params(value: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
+    def affected_targets=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def detail; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def detail=(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/artifact_freshness.rbi

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module Retab
+  class ArtifactFreshness
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(T.nilable(String)) }
+    def status; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def status=(value); end
+
+    sig { returns(T.nilable(T::Array[String])) }
+    def reasons; end
+
+    sig { params(value: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
+    def reasons=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def validity_fingerprint; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def validity_fingerprint=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def input_fingerprint; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def input_fingerprint=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def baseline_run_id; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def baseline_run_id=(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/create_upload_response.rbi

@@ -33,10 +33,10 @@ module Retab
     sig { params(value: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String])) }
     def upload_headers=(value); end
 
-    sig { returns(Retab::MimeData) }
+    sig { returns(T.nilable(Retab::MimeData)) }
     def mime_data; end
 
-    sig { params(value: Retab::MimeData).returns(Retab::MimeData) }
+    sig { params(value: T.nilable(Retab::MimeData)).returns(T.nilable(Retab::MimeData)) }
     def mime_data=(value); end
 
     sig { returns(String) }

data/rbi/retab/create_workflow_request.rbi

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

data/rbi/retab/{body_create_table_v_1_tables_post.rbi → create_workflow_table_upload_request.rbi}

@@ -5,7 +5,7 @@
 # typed: strong
 
 module Retab
-  class BodyCreateTableV1TablesPost
+  class CreateWorkflowTableUploadRequest
     sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
     def initialize(json); end
 
@@ -27,6 +27,12 @@ module Retab
     sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
     def column_schema_overrides=(value); end
 
+    sig { returns(T.nilable(String)) }
+    def project_id; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def project_id=(value); end
+
     sig { returns(T::Hash[Symbol, T.untyped]) }
     def to_h; end
 

data/rbi/retab/declarative_workflow_request.rbi

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

data/rbi/retab/experiment_result.rbi

@@ -16,10 +16,10 @@ module Retab
     def id=(value); end
 
     sig { returns(String) }
-    def run_id; end
+    def experiment_run_id; end
 
     sig { params(value: String).returns(String) }
-    def run_id=(value); end
+    def experiment_run_id=(value); end
 
     sig { returns(String) }
     def experiment_id; end
@@ -57,6 +57,12 @@ module Retab
     sig { params(value: T.nilable(T::Hash[String, T.any(Retab::JsonHandleInput, Retab::FileHandleInput)])).returns(T.nilable(T::Hash[String, T.any(Retab::JsonHandleInput, Retab::FileHandleInput)])) }
     def handle_inputs=(value); end
 
+    sig { returns(T.nilable(T::Hash[String, T.any(Retab::JsonHandleInput, Retab::FileHandleInput)])) }
+    def handle_outputs; end
+
+    sig { params(value: T.nilable(T::Hash[String, T.any(Retab::JsonHandleInput, Retab::FileHandleInput)])).returns(T.nilable(T::Hash[String, T.any(Retab::JsonHandleInput, Retab::FileHandleInput)])) }
+    def handle_outputs=(value); end
+
     sig { returns(T.nilable(Retab::StepArtifactRef)) }
     def artifact; end
 

data/rbi/retab/experiment_run.rbi

@@ -75,6 +75,24 @@ module Retab
     sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
     def parent_run_id=(value); end
 
+    sig { returns(T.nilable(String)) }
+    def block_version_id; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def block_version_id=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def metrics_validity_fingerprint; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def metrics_validity_fingerprint=(value); end
+
+    sig { returns(T.nilable(Integer)) }
+    def metrics_validity_fingerprint_version; end
+
+    sig { params(value: T.nilable(Integer)).returns(T.nilable(Integer)) }
+    def metrics_validity_fingerprint_version=(value); end
+
     sig { returns(String) }
     def definition_fingerprint; end
 

data/rbi/retab/file_handle_input.rbi

@@ -15,10 +15,10 @@ module Retab
     sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
     def type=(value); end
 
-    sig { returns(Retab::MaterializedDocument) }
+    sig { returns(Retab::FileRef) }
     def document; end
 
-    sig { params(value: Retab::MaterializedDocument).returns(Retab::MaterializedDocument) }
+    sig { params(value: Retab::FileRef).returns(Retab::FileRef) }
     def document=(value); end
 
     sig { returns(T::Hash[Symbol, T.untyped]) }

data/rbi/retab/latest_block_test_run_summary.rbi

@@ -57,6 +57,18 @@ module Retab
     sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
     def block_config_fingerprint=(value); end
 
+    sig { returns(T.nilable(String)) }
+    def validity_fingerprint; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def validity_fingerprint=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def handle_inputs_fingerprint; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def handle_inputs_fingerprint=(value); end
+
     sig { returns(T.nilable(Integer)) }
     def assertions_passed; end
 

data/rbi/retab/{body_replace_table_v_1_tables_table_id_put.rbi → replace_workflow_table_upload_request.rbi}

@@ -5,7 +5,7 @@
 # typed: strong
 
 module Retab
-  class BodyReplaceTableV1TablesTableIdPut
+  class ReplaceWorkflowTableUploadRequest
     sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
     def initialize(json); end
 

data/rbi/retab/stored_block_execution.rbi

@@ -22,10 +22,10 @@ module Retab
     def workflow_id=(value); end
 
     sig { returns(String) }
-    def run_id; end
+    def source_run_id; end
 
     sig { params(value: String).returns(String) }
-    def run_id=(value); end
+    def source_run_id=(value); end
 
     sig { returns(String) }
     def block_id; end
@@ -88,10 +88,10 @@ module Retab
     def block_config=(value); end
 
     sig { returns(T.nilable(String)) }
-    def step_id; end
+    def source_step_id; end
 
     sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
-    def step_id=(value); end
+    def source_step_id=(value); end
 
     sig { returns(T.nilable(T::Array[T::Hash[String, T.untyped]])) }
     def available_iterations; end

data/rbi/retab/tables.rbi

@@ -11,20 +11,22 @@ module Retab
 
     sig do
       params(
+        project_id: T.nilable(String),
         request_options: T::Hash[Symbol, T.untyped]
       ).returns(Retab::WorkflowTableListResponse)
     end
-    def list(request_options:); end
+    def list(project_id:, request_options:); end
 
     sig do
       params(
         name: String,
         file: String,
         column_schema_overrides: T.nilable(String),
+        project_id: T.nilable(String),
         request_options: T::Hash[Symbol, T.untyped]
       ).returns(Retab::WorkflowTableListResponse)
     end
-    def create(name:, file:, column_schema_overrides:, request_options:); end
+    def create(name:, file:, column_schema_overrides:, project_id:, request_options:); end
 
     sig do
       params(
@@ -58,7 +60,7 @@ module Retab
       params(
         table_id: String,
         request_options: T::Hash[Symbol, T.untyped]
-      ).returns(Retab::WorkflowTableListResponse)
+      ).returns(NilClass)
     end
     def delete(table_id:, request_options:); end
 
@@ -66,7 +68,7 @@ module Retab
       params(
         table_id: String,
         request_options: T::Hash[Symbol, T.untyped]
-      ).returns(NilClass)
+      ).returns(String)
     end
     def download(table_id:, request_options:); end
 

data/rbi/retab/workflow.rbi

@@ -27,6 +27,12 @@ module Retab
     sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
     def description=(value); end
 
+    sig { returns(T.nilable(String)) }
+    def project_id; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def project_id=(value); end
+
     sig { returns(T.nilable(Retab::WorkflowPublished)) }
     def published; end
 
@@ -45,6 +51,18 @@ module Retab
     sig { params(value: String).returns(String) }
     def updated_at=(value); end
 
+    sig { returns(T.nilable(T::Array[String])) }
+    def capabilities; end
+
+    sig { params(value: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
+    def capabilities=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def authz_status; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def authz_status=(value); end
+
     sig { returns(T::Hash[Symbol, T.untyped]) }
     def to_h; end
 

data/rbi/retab/workflow_block_position.rbi

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module Retab
+  class WorkflowBlockPosition
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(Float) }
+    def x; end
+
+    sig { params(value: Float).returns(Float) }
+    def x=(value); end
+
+    sig { returns(Float) }
+    def y; end
+
+    sig { params(value: Float).returns(Float) }
+    def y=(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