retab 0.1.5 → 0.1.7

data/lib/retab/tables/workflow_table_rows_response.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class WorkflowTableRowsResponse < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      table_id: :table_id,
+      columns: :columns,
+      rows: :rows,
+      row_count: :row_count,
+      filtered_row_count: :filtered_row_count,
+      offset: :offset,
+      limit: :limit,
+      has_more: :has_more,
+      next_cursor: :next_cursor,
+      previous_cursor: :previous_cursor,
+      explain: :explain
+    }.freeze
+
+    attr_accessor(
+      :table_id,
+      :columns,
+      :rows,
+      :row_count,
+      :filtered_row_count,
+      :offset,
+      :limit,
+      :has_more,
+      :next_cursor,
+      :previous_cursor,
+      :explain
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @table_id = hash[:table_id]
+      @columns = (hash[:columns] || []).map { |item| item ? Retab::WorkflowTableColumn.new(item) : nil }
+      @rows = (hash[:rows] || []).map { |item| item ? Retab::WorkflowTableRow.new(item) : nil }
+      @row_count = hash[:row_count]
+      @filtered_row_count = hash[:filtered_row_count]
+      @offset = hash[:offset]
+      @limit = hash[:limit]
+      @has_more = hash[:has_more].nil? ? false : hash[:has_more]
+      @next_cursor = hash[:next_cursor]
+      @previous_cursor = hash[:previous_cursor]
+      @explain = hash[:explain] ? Retab::WorkflowTableExplain.new(hash[:explain]) : nil
+    end
+  end
+end

data/lib/retab/tables/workflow_table_sample_request.rb

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

data/lib/retab/tables/workflow_table_schema_response.rb

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

data/lib/retab/tables/workflow_table_search_request.rb

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

data/lib/retab/tables/workflow_table_sort_rule.rb

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

data/lib/retab/tables/workflow_table_tail_request.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  WorkflowTableTailRequest = WorkflowTableSampleRequest
+end

data/lib/retab/tables/workflow_table_validation_column_rule.rb

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

data/lib/retab/tables/workflow_table_validation_diagnostic.rb

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

data/lib/retab/tables/workflow_table_validation_request.rb

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

data/lib/retab/tables/workflow_table_validation_response.rb

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

data/lib/retab/tables.rb

@@ -0,0 +1,361 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require "json"
+
+module Retab
+  class Tables
+    def initialize(client)
+      @client = client
+    end
+
+    # Table.List
+    # @param project_id [String, nil] Only return tables belonging to this project.
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowTableListResponse]
+    def list(
+      project_id: nil,
+      request_options: {}
+    )
+      params = {
+        "project_id" => project_id
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/v1/tables",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      result = Retab::WorkflowTableListResponse.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
+
+    # Table.Create
+    # @param name [String]
+    # @param file [String, IO, Pathname]
+    # @param column_schema_overrides [String, nil]
+    # @param project_id [String, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowTableListResponse]
+    def create(
+      name:,
+      file:,
+      column_schema_overrides: nil,
+      project_id: nil,
+      request_options: {}
+    )
+      multipart_fields = {}
+      multipart_fields["name"] = name unless name.nil?
+      multipart_fields["file"] = Retab::Multipart::FilePart.new(file, filename: "file") unless file.nil?
+      multipart_fields["column_schema_overrides"] = column_schema_overrides unless column_schema_overrides.nil?
+      multipart_fields["project_id"] = project_id unless project_id.nil?
+      body = Retab::Multipart.new(multipart_fields)
+      response = @client.request(
+        method: :post,
+        path: "/v1/tables",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::WorkflowTableListResponse.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
+
+    # Table.Get
+    # @param table_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowTableResponse]
+    def get(
+      table_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/tables/#{Retab::Util.encode_path(table_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::WorkflowTableResponse.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
+
+    # Table.Replace
+    # @param table_id [String]
+    # @param file [String, IO, Pathname]
+    # @param column_schema_overrides [String, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowTableListResponse]
+    def replace(
+      table_id:,
+      file:,
+      column_schema_overrides: nil,
+      request_options: {}
+    )
+      multipart_fields = {}
+      multipart_fields["file"] = Retab::Multipart::FilePart.new(file, filename: "file") unless file.nil?
+      multipart_fields["column_schema_overrides"] = column_schema_overrides unless column_schema_overrides.nil?
+      body = Retab::Multipart.new(multipart_fields)
+      response = @client.request(
+        method: :put,
+        path: "/v1/tables/#{Retab::Util.encode_path(table_id)}",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::WorkflowTableListResponse.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
+
+    # Table.Update
+    # @param table_id [String]
+    # @param name [String, nil]
+    # @param metadata [Hash{String => Object}, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowTableListResponse]
+    def update_table(
+      table_id:,
+      name: nil,
+      metadata: nil,
+      request_options: {}
+    )
+      body = {
+        "name" => name,
+        "metadata" => metadata
+      }.compact
+      response = @client.request(
+        method: :patch,
+        path: "/v1/tables/#{Retab::Util.encode_path(table_id)}",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::WorkflowTableListResponse.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
+
+    # Table.Delete
+    # @param table_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [void]
+    def delete(
+      table_id:,
+      request_options: {}
+    )
+      @client.request(
+        method: :delete,
+        path: "/v1/tables/#{Retab::Util.encode_path(table_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      nil
+    end
+
+    # Table.Download
+    # @param table_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [String]
+    def download(
+      table_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/tables/#{Retab::Util.encode_path(table_id)}/download",
+        auth: true,
+        request_options: request_options
+      )
+      response.body
+    end
+
+    # Table.Get Profile
+    # @param table_id [String]
+    # @param select [Array<String>, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowTableProfileResponse]
+    def profile(
+      table_id:,
+      select: nil,
+      request_options: {}
+    )
+      params = {
+        "select" => select
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/v1/tables/#{Retab::Util.encode_path(table_id)}/profile",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      result = Retab::WorkflowTableProfileResponse.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
+
+    # Table.Query
+    # @param table_id [String]
+    # @param filters [Array<Retab::WorkflowTableFilterRule>, nil]
+    # @param search [Retab::WorkflowTableSearchRequest, nil]
+    # @param case_sensitive [Boolean, nil]
+    # @param select [Array<String>, nil]
+    # @param distinct [Retab::WorkflowTableDistinctRequest, nil]
+    # @param group_by [Array<String>, nil]
+    # @param aggregations [Array<Retab::WorkflowTableAggregationRequest>, nil]
+    # @param sort [Array<Retab::WorkflowTableSortRule>, nil]
+    # @param sample [Retab::WorkflowTableSampleRequest, nil]
+    # @param tail [Retab::WorkflowTableTailRequest, nil]
+    # @param count_only [Boolean, nil]
+    # @param include_explain [Boolean, nil]
+    # @param sort_column [String, nil]
+    # @param sort_direction [Retab::Types::WorkflowTableSortDirection, nil]
+    # @param viewer_mode [String, nil]
+    # @param offset [Integer, nil]
+    # @param limit [Integer, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowTableRowsResponse]
+    def query(
+      table_id:,
+      filters: nil,
+      search: nil,
+      case_sensitive: nil,
+      select: nil,
+      distinct: nil,
+      group_by: nil,
+      aggregations: nil,
+      sort: nil,
+      sample: nil,
+      tail: nil,
+      count_only: nil,
+      include_explain: nil,
+      sort_column: nil,
+      sort_direction: nil,
+      viewer_mode: nil,
+      offset: nil,
+      limit: nil,
+      request_options: {}
+    )
+      body = {
+        "filters" => filters,
+        "search" => search,
+        "case_sensitive" => case_sensitive,
+        "select" => select,
+        "distinct" => distinct,
+        "group_by" => group_by,
+        "aggregations" => aggregations,
+        "sort" => sort,
+        "sample" => sample,
+        "tail" => tail,
+        "count_only" => count_only,
+        "include_explain" => include_explain,
+        "sort_column" => sort_column,
+        "sort_direction" => sort_direction,
+        "viewer_mode" => viewer_mode,
+        "offset" => offset,
+        "limit" => limit
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: "/v1/tables/#{Retab::Util.encode_path(table_id)}/query",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::WorkflowTableRowsResponse.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
+
+    # Table.Get Schema
+    # @param table_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowTableSchemaResponse]
+    def schema(
+      table_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/tables/#{Retab::Util.encode_path(table_id)}/schema",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::WorkflowTableSchemaResponse.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
+
+    # Table.Validate
+    # @param table_id [String]
+    # @param required_columns [Array<String>, nil]
+    # @param columns [Hash{String => Retab::WorkflowTableValidationColumnRule}, nil]
+    # @param unique [Array<Array<String>>, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::WorkflowTableValidationResponse]
+    def validate(
+      table_id:,
+      required_columns: nil,
+      columns: nil,
+      unique: nil,
+      request_options: {}
+    )
+      body = {
+        "required_columns" => required_columns,
+        "columns" => columns,
+        "unique" => unique
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: "/v1/tables/#{Retab::Util.encode_path(table_id)}/validate",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::WorkflowTableValidationResponse.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
+  end
+end

data/lib/retab/types/artifact_drift_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    class ArtifactDriftStatus
+      NONE = "none"
+      DRIFTED = "drifted"
+      BROKEN = "broken"
+      UNKNOWN = "unknown"
+      ALL = [NONE, DRIFTED, BROKEN, UNKNOWN].freeze
+    end
+  end
+end

data/lib/retab/types/artifact_freshness_reasons.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    class ArtifactFreshnessReasons
+      VALIDITY_CHANGED = "validity_changed"
+      INPUTS_CHANGED = "inputs_changed"
+      ENGINE_CHANGED = "engine_changed"
+      METRICS_ENGINE_CHANGED = "metrics_engine_changed"
+      NO_BASELINE = "no_baseline"
+      ALL = [VALIDITY_CHANGED, INPUTS_CHANGED, ENGINE_CHANGED, METRICS_ENGINE_CHANGED, NO_BASELINE].freeze
+    end
+  end
+end

data/lib/retab/types/artifact_freshness_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    class ArtifactFreshnessStatus
+      FRESH = "fresh"
+      STALE = "stale"
+      UNKNOWN = "unknown"
+      ALL = [FRESH, STALE, UNKNOWN].freeze
+    end
+  end
+end