openlayer 0.14.1 → 0.16.0

data/lib/openlayer/resources/storage/presigned_url.rb

@@ -27,6 +27,38 @@ module Openlayer
           )
         end
 
+        # Exchange a `storageUri` for a short-lived presigned url you can download the
+        # object from.
+        #
+        # Use it to collect anything the platform stored on your behalf -- for example the
+        # archive a framework export leaves behind, whose `storageUri` comes back in the
+        # background task's `outputs`.
+        #
+        # The workspace is taken from the API key, so there is nothing else to send. The
+        # url is only issued for objects your workspace owns, and `404` covers both "no
+        # such object" and "not yours".
+        #
+        # @overload retrieve(storage_uri:, request_options: {})
+        #
+        # @param storage_uri [String] The object's storage uri.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Storage::PresignedURLRetrieveResponse]
+        #
+        # @see Openlayer::Models::Storage::PresignedURLRetrieveParams
+        def retrieve(params)
+          parsed, options = Openlayer::Storage::PresignedURLRetrieveParams.dump_request(params)
+          query = Openlayer::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "storage/presigned-url",
+            query: query.transform_keys(storage_uri: "storageUri"),
+            model: Openlayer::Models::Storage::PresignedURLRetrieveResponse,
+            options: options
+          )
+        end
+
         # @api private
         #
         # @param client [Openlayer::Client]

data/lib/openlayer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Openlayer
-  VERSION = "0.14.1"
+  VERSION = "0.16.0"
 end

data/lib/openlayer.rb

@@ -52,10 +52,59 @@ require_relative "openlayer/errors"
 require_relative "openlayer/internal/transport/base_client"
 require_relative "openlayer/internal/transport/pooled_net_requester"
 require_relative "openlayer/client"
+require_relative "openlayer/models/background_task_retrieve_params"
+require_relative "openlayer/models/background_task_retrieve_response"
 require_relative "openlayer/models/commit_retrieve_params"
 require_relative "openlayer/models/commit_retrieve_response"
 require_relative "openlayer/models/commits/test_result_list_params"
 require_relative "openlayer/models/commits/test_result_list_response"
+require_relative "openlayer/models/governance/framework_create_params"
+require_relative "openlayer/models/governance/framework_create_response"
+require_relative "openlayer/models/governance/framework_export_params"
+require_relative "openlayer/models/governance/framework_export_response"
+require_relative "openlayer/models/governance/framework_list_params"
+require_relative "openlayer/models/governance/framework_list_project_rule_stats_params"
+require_relative "openlayer/models/governance/framework_list_project_rule_stats_response"
+require_relative "openlayer/models/governance/framework_list_projects_params"
+require_relative "openlayer/models/governance/framework_list_projects_response"
+require_relative "openlayer/models/governance/framework_list_response"
+require_relative "openlayer/models/governance/framework_list_rules_params"
+require_relative "openlayer/models/governance/framework_list_rules_response"
+require_relative "openlayer/models/governance/framework_retrieve_params"
+require_relative "openlayer/models/governance/framework_retrieve_response"
+require_relative "openlayer/models/governance/frameworks/document_list_params"
+require_relative "openlayer/models/governance/frameworks/document_list_response"
+require_relative "openlayer/models/governance/frameworks/document_retrieve_params"
+require_relative "openlayer/models/governance/frameworks/document_retrieve_response"
+require_relative "openlayer/models/governance/frameworks/section_list_rules_params"
+require_relative "openlayer/models/governance/frameworks/section_list_rules_response"
+require_relative "openlayer/models/governance/frameworks/subsection_list_rules_params"
+require_relative "openlayer/models/governance/frameworks/subsection_list_rules_response"
+require_relative "openlayer/models/governance/framework_update_params"
+require_relative "openlayer/models/governance/framework_update_response"
+require_relative "openlayer/models/governance/rule_create_params"
+require_relative "openlayer/models/governance/rule_create_response"
+require_relative "openlayer/models/governance/rule_delete_params"
+require_relative "openlayer/models/governance/rule_list_params"
+require_relative "openlayer/models/governance/rule_list_response"
+require_relative "openlayer/models/governance/rule_result_create_evidence_params"
+require_relative "openlayer/models/governance/rule_result_create_evidence_response"
+require_relative "openlayer/models/governance/rule_result_list_evidence_params"
+require_relative "openlayer/models/governance/rule_result_list_evidence_response"
+require_relative "openlayer/models/governance/rule_result_list_params"
+require_relative "openlayer/models/governance/rule_result_list_response"
+require_relative "openlayer/models/governance/rule_result_retrieve_params"
+require_relative "openlayer/models/governance/rule_result_retrieve_response"
+require_relative "openlayer/models/governance/rule_result_update_params"
+require_relative "openlayer/models/governance/rule_result_update_response"
+require_relative "openlayer/models/governance/rule_retrieve_params"
+require_relative "openlayer/models/governance/rule_retrieve_response"
+require_relative "openlayer/models/governance/rule_stat_retrieve_params"
+require_relative "openlayer/models/governance/rule_stat_retrieve_response"
+require_relative "openlayer/models/governance/rule_tag_list_params"
+require_relative "openlayer/models/governance/rule_tag_list_response"
+require_relative "openlayer/models/governance/rule_update_params"
+require_relative "openlayer/models/governance/rule_update_response"
 require_relative "openlayer/models/inference_pipeline_delete_params"
 require_relative "openlayer/models/inference_pipeline_retrieve_params"
 require_relative "openlayer/models/inference_pipeline_retrieve_response"
@@ -95,8 +144,12 @@ require_relative "openlayer/models/projects/test_list_params"
 require_relative "openlayer/models/projects/test_list_response"
 require_relative "openlayer/models/projects/test_update_params"
 require_relative "openlayer/models/projects/test_update_response"
+require_relative "openlayer/models/project_update_params"
+require_relative "openlayer/models/project_update_response"
 require_relative "openlayer/models/storage/presigned_url_create_params"
 require_relative "openlayer/models/storage/presigned_url_create_response"
+require_relative "openlayer/models/storage/presigned_url_retrieve_params"
+require_relative "openlayer/models/storage/presigned_url_retrieve_response"
 require_relative "openlayer/models/test_evaluate_params"
 require_relative "openlayer/models/test_evaluate_response"
 require_relative "openlayer/models/test_list_results_params"
@@ -112,8 +165,18 @@ require_relative "openlayer/models/workspaces/invite_list_response"
 require_relative "openlayer/models/workspace_update_params"
 require_relative "openlayer/models/workspace_update_response"
 require_relative "openlayer/models"
+require_relative "openlayer/resources/background_tasks"
 require_relative "openlayer/resources/commits"
 require_relative "openlayer/resources/commits/test_results"
+require_relative "openlayer/resources/governance"
+require_relative "openlayer/resources/governance/frameworks"
+require_relative "openlayer/resources/governance/frameworks/documents"
+require_relative "openlayer/resources/governance/frameworks/sections"
+require_relative "openlayer/resources/governance/frameworks/subsections"
+require_relative "openlayer/resources/governance/rule_results"
+require_relative "openlayer/resources/governance/rules"
+require_relative "openlayer/resources/governance/rule_stats"
+require_relative "openlayer/resources/governance/rule_tags"
 require_relative "openlayer/resources/inference_pipelines"
 require_relative "openlayer/resources/inference_pipelines/data"
 require_relative "openlayer/resources/inference_pipelines/rows"

data/rbi/openlayer/client.rbi

@@ -31,6 +31,12 @@ module Openlayer
     sig { returns(Openlayer::Resources::Tests) }
     attr_reader :tests
 
+    sig { returns(Openlayer::Resources::BackgroundTasks) }
+    attr_reader :background_tasks
+
+    sig { returns(Openlayer::Resources::Governance) }
+    attr_reader :governance
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/openlayer/models/background_task_retrieve_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    class BackgroundTaskRetrieveParams < Openlayer::Internal::Type::BaseModel
+      extend Openlayer::Internal::Type::RequestParameters::Converter
+      include Openlayer::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Openlayer::BackgroundTaskRetrieveParams,
+            Openlayer::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :task_id
+
+      sig do
+        params(
+          task_id: String,
+          request_options: Openlayer::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(task_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { task_id: String, request_options: Openlayer::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/openlayer/models/background_task_retrieve_response.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    class BackgroundTaskRetrieveResponse < Openlayer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Openlayer::Models::BackgroundTaskRetrieveResponse,
+            Openlayer::Internal::AnyHash
+          )
+        end
+
+      # Whether the task has finished. Check this before reading `outputs`.
+      sig { returns(T::Boolean) }
+      attr_accessor :complete
+
+      # How far along the task is, from 0 to 100.
+      sig { returns(Float) }
+      attr_accessor :progress
+
+      # Why the task failed, or `null` if it has not failed.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :error
+
+      # Whatever the task produced, keyed by name. `null` until the task completes. A
+      # framework export returns `storageUri` -- pass it to `GET /storage/presigned-url`
+      # to download the archive -- along with `filename`, `controlCount`,
+      # `evidenceCount` and `missingEvidenceCount`.
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :outputs
+
+      # The background task id.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # When the task was queued.
+      sig { returns(Time) }
+      attr_accessor :date_created
+
+      # When the task last reported progress.
+      sig { returns(Time) }
+      attr_accessor :date_updated
+
+      # The task's internal name, including the arguments it was queued with.
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig do
+        params(
+          id: String,
+          complete: T::Boolean,
+          date_created: Time,
+          date_updated: Time,
+          name: String,
+          progress: Float,
+          error: T.nilable(String),
+          outputs: T.nilable(T.anything)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The background task id.
+        id:,
+        # Whether the task has finished. Check this before reading `outputs`.
+        complete:,
+        # When the task was queued.
+        date_created:,
+        # When the task last reported progress.
+        date_updated:,
+        # The task's internal name, including the arguments it was queued with.
+        name:,
+        # How far along the task is, from 0 to 100.
+        progress:,
+        # Why the task failed, or `null` if it has not failed.
+        error: nil,
+        # Whatever the task produced, keyed by name. `null` until the task completes. A
+        # framework export returns `storageUri` -- pass it to `GET /storage/presigned-url`
+        # to download the archive -- along with `filename`, `controlCount`,
+        # `evidenceCount` and `missingEvidenceCount`.
+        outputs: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            complete: T::Boolean,
+            date_created: Time,
+            date_updated: Time,
+            name: String,
+            progress: Float,
+            error: T.nilable(String),
+            outputs: T.nilable(T.anything)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/openlayer/models/governance/framework_create_params.rbi

@@ -0,0 +1,298 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Governance
+      class FrameworkCreateParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Governance::FrameworkCreateParams,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :workspace_id
+
+        # The framework name.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # A short description of the framework.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # Whether the framework is active. Rules of a disabled framework are not evaluated
+        # and do not count towards compliance.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :enabled
+
+        sig { params(enabled: T::Boolean).void }
+        attr_writer :enabled
+
+        # Determines which projects the framework applies to. An empty or `null` `match`
+        # array applies the framework to every project in the workspace.
+        sig do
+          returns(
+            T.nilable(
+              Openlayer::Governance::FrameworkCreateParams::ProjectSelector
+            )
+          )
+        end
+        attr_reader :project_selector
+
+        sig do
+          params(
+            project_selector:
+              T.nilable(
+                Openlayer::Governance::FrameworkCreateParams::ProjectSelector::OrHash
+              )
+          ).void
+        end
+        attr_writer :project_selector
+
+        # Free-form labels on the framework.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :tags
+
+        sig { params(tags: T::Array[String]).void }
+        attr_writer :tags
+
+        sig do
+          params(
+            workspace_id: String,
+            name: String,
+            description: T.nilable(String),
+            enabled: T::Boolean,
+            project_selector:
+              T.nilable(
+                Openlayer::Governance::FrameworkCreateParams::ProjectSelector::OrHash
+              ),
+            tags: T::Array[String],
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          workspace_id:,
+          # The framework name.
+          name:,
+          # A short description of the framework.
+          description: nil,
+          # Whether the framework is active. Rules of a disabled framework are not evaluated
+          # and do not count towards compliance.
+          enabled: nil,
+          # Determines which projects the framework applies to. An empty or `null` `match`
+          # array applies the framework to every project in the workspace.
+          project_selector: nil,
+          # Free-form labels on the framework.
+          tags: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              workspace_id: String,
+              name: String,
+              description: T.nilable(String),
+              enabled: T::Boolean,
+              project_selector:
+                T.nilable(
+                  Openlayer::Governance::FrameworkCreateParams::ProjectSelector
+                ),
+              tags: T::Array[String],
+              request_options: Openlayer::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class ProjectSelector < Openlayer::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Openlayer::Governance::FrameworkCreateParams::ProjectSelector,
+                Openlayer::Internal::AnyHash
+              )
+            end
+
+          # Match criteria, ANDed together.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match
+                ]
+              )
+            )
+          end
+          attr_accessor :match
+
+          # Determines which projects the framework applies to. An empty or `null` `match`
+          # array applies the framework to every project in the workspace.
+          sig do
+            params(
+              match:
+                T.nilable(
+                  T::Array[
+                    Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match::OrHash
+                  ]
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Match criteria, ANDed together.
+            match: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                match:
+                  T.nilable(
+                    T::Array[
+                      Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match
+                    ]
+                  )
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Match < Openlayer::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match,
+                  Openlayer::Internal::AnyHash
+                )
+              end
+
+            # The project property to match against.
+            sig do
+              returns(
+                Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match::Property::OrSymbol
+              )
+            end
+            attr_accessor :property
+
+            # The value to match against. Pass an array to match any of several values, or
+            # `null` to match projects where the property is unset. Omit it for `exists` and
+            # `notExists`.
+            sig { returns(T.anything) }
+            attr_accessor :value
+
+            # How to compare the project property with `value`. One of `equals`, `notEquals`,
+            # `contains`, `notContains`, `startsWith`, `endsWith`, `in`, `notIn`,
+            # `greaterThan`, `greaterThanOrEqual`, `lessThan`, `lessThanOrEqual`,
+            # `equalsIgnoreCase`, `containsIgnoreCase`, `matches`, `exists`, or `notExists`.
+            sig { returns(T.nilable(String)) }
+            attr_reader :operator
+
+            sig { params(operator: String).void }
+            attr_writer :operator
+
+            sig do
+              params(
+                property:
+                  Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match::Property::OrSymbol,
+                value: T.anything,
+                operator: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The project property to match against.
+              property:,
+              # The value to match against. Pass an array to match any of several values, or
+              # `null` to match projects where the property is unset. Omit it for `exists` and
+              # `notExists`.
+              value:,
+              # How to compare the project property with `value`. One of `equals`, `notEquals`,
+              # `contains`, `notContains`, `startsWith`, `endsWith`, `in`, `notIn`,
+              # `greaterThan`, `greaterThanOrEqual`, `lessThan`, `lessThanOrEqual`,
+              # `equalsIgnoreCase`, `containsIgnoreCase`, `matches`, `exists`, or `notExists`.
+              operator: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  property:
+                    Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match::Property::OrSymbol,
+                  value: T.anything,
+                  operator: String
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The project property to match against.
+            module Property
+              extend Openlayer::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match::Property
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              TASK_TYPE =
+                T.let(
+                  :taskType,
+                  Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match::Property::TaggedSymbol
+                )
+              RISK_LEVEL =
+                T.let(
+                  :riskLevel,
+                  Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match::Property::TaggedSymbol
+                )
+              RISK_TOTAL_SCORE =
+                T.let(
+                  :riskTotalScore,
+                  Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match::Property::TaggedSymbol
+                )
+              NAME =
+                T.let(
+                  :name,
+                  Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match::Property::TaggedSymbol
+                )
+              OWNER_ID =
+                T.let(
+                  :ownerId,
+                  Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match::Property::TaggedSymbol
+                )
+              MODEL_TYPES =
+                T.let(
+                  :modelTypes,
+                  Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match::Property::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match::Property::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end