openlayer 0.15.0 → 0.17.0

data/rbi/openlayer/resources/governance/frameworks.rbi

@@ -0,0 +1,261 @@
+# typed: strong
+
+module Openlayer
+  module Resources
+    class Governance
+      class Frameworks
+        sig { returns(Openlayer::Resources::Governance::Frameworks::Documents) }
+        attr_reader :documents
+
+        sig { returns(Openlayer::Resources::Governance::Frameworks::Sections) }
+        attr_reader :sections
+
+        sig do
+          returns(Openlayer::Resources::Governance::Frameworks::Subsections)
+        end
+        attr_reader :subsections
+
+        # Create a custom framework in a workspace.
+        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(Openlayer::Models::Governance::FrameworkCreateResponse)
+        end
+        def create(
+          # The workspace id.
+          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
+
+        # Retrieve a framework.
+        sig do
+          params(
+            framework_id: String,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Governance::FrameworkRetrieveResponse)
+        end
+        def retrieve(
+          # The framework id.
+          framework_id,
+          request_options: {}
+        )
+        end
+
+        # Update a framework.
+        sig do
+          params(
+            framework_id: String,
+            avatar:
+              T.nilable(
+                Openlayer::Governance::FrameworkUpdateParams::Avatar::OrHash
+              ),
+            description: T.nilable(String),
+            enabled: T::Boolean,
+            extended_description: T.nilable(T::Hash[Symbol, T.anything]),
+            href: T.nilable(String),
+            name: String,
+            project_selector:
+              T.nilable(
+                Openlayer::Governance::FrameworkUpdateParams::ProjectSelector::OrHash
+              ),
+            tags: T::Array[String],
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Governance::FrameworkUpdateResponse)
+        end
+        def update(
+          # The framework id.
+          framework_id,
+          # The icon shown for the framework.
+          avatar: nil,
+          # 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,
+          # A longer, rich-text description, as a TipTap JSON document.
+          extended_description: nil,
+          # A link to the external standard or regulation the framework is based on.
+          href: nil,
+          # The framework name.
+          name: 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
+
+        # List the frameworks in a workspace.
+        sig do
+          params(
+            workspace_id: String,
+            asc: T::Boolean,
+            completion_operator:
+              Openlayer::Governance::FrameworkListParams::CompletionOperator::OrSymbol,
+            completion_value: Integer,
+            enabled: T::Boolean,
+            include_rule_stats: T::Boolean,
+            page: Integer,
+            per_page: Integer,
+            project_id: String,
+            search_query: String,
+            sort_column:
+              Openlayer::Governance::FrameworkListParams::SortColumn::OrSymbol,
+            tags: T::Array[String],
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Governance::FrameworkListResponse)
+        end
+        def list(
+          # The workspace id.
+          workspace_id,
+          # Whether to sort in ascending order.
+          asc: nil,
+          # How to compare each framework's completion percentage with `completionValue`.
+          # Must be sent together with `completionValue`.
+          completion_operator: nil,
+          # The completion percentage to compare against, from 0 to 100.
+          completion_value: nil,
+          # Only include frameworks that are enabled (or disabled).
+          enabled: nil,
+          # Whether to include a `ruleStats` object on each framework, with its rule result
+          # status counts and its per-project completion buckets. Computed over the returned
+          # page only.
+          include_rule_stats: nil,
+          # The page to return in a paginated query.
+          page: nil,
+          # Maximum number of items to return per page.
+          per_page: nil,
+          # Only include items that apply to this project.
+          project_id: nil,
+          # Filter by a free-text search over names and descriptions.
+          search_query: nil,
+          # The column to sort on.
+          sort_column: nil,
+          # Only include frameworks carrying all of these tags.
+          tags: nil,
+          request_options: {}
+        )
+        end
+
+        # Export a framework as an audit-ready zip archive.
+        sig do
+          params(
+            framework_id: String,
+            project_id: T.nilable(String),
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Governance::FrameworkExportResponse)
+        end
+        def export(
+          # The framework id.
+          framework_id,
+          # Scope the export to this project. It must belong to the framework. Omit it for
+          # the workspace-wide view across every project in the framework, including
+          # workspace-scoped rules.
+          project_id: nil,
+          request_options: {}
+        )
+        end
+
+        # List a framework's compliance stats per project.
+        sig do
+          params(
+            framework_id: String,
+            asc: T::Boolean,
+            page: Integer,
+            per_page: Integer,
+            sort_column:
+              Openlayer::Governance::FrameworkListProjectRuleStatsParams::SortColumn::OrSymbol,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(
+            Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse
+          )
+        end
+        def list_project_rule_stats(
+          # The framework id.
+          framework_id,
+          # Whether to sort in ascending order.
+          asc: nil,
+          # The page to return in a paginated query.
+          page: nil,
+          # Maximum number of items to return per page.
+          per_page: nil,
+          # The column to sort on.
+          sort_column: nil,
+          request_options: {}
+        )
+        end
+
+        # List the projects a framework applies to.
+        sig do
+          params(
+            framework_id: String,
+            page: Integer,
+            per_page: Integer,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(
+            Openlayer::Models::Governance::FrameworkListProjectsResponse
+          )
+        end
+        def list_projects(
+          # The framework id.
+          framework_id,
+          # The page to return in a paginated query.
+          page: nil,
+          # Maximum number of items to return per page.
+          per_page: nil,
+          request_options: {}
+        )
+        end
+
+        # List the rules in a framework.
+        sig do
+          params(
+            framework_id: String,
+            page: Integer,
+            per_page: Integer,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Governance::FrameworkListRulesResponse)
+        end
+        def list_rules(
+          # The framework id.
+          framework_id,
+          # The page to return in a paginated query.
+          page: nil,
+          # Maximum number of items to return per page.
+          per_page: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Openlayer::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/resources/governance/rule_results.rbi

@@ -0,0 +1,167 @@
+# typed: strong
+
+module Openlayer
+  module Resources
+    class Governance
+      class RuleResults
+        # Retrieve a rule result.
+        sig do
+          params(
+            rule_result_id: String,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Governance::RuleResultRetrieveResponse)
+        end
+        def retrieve(
+          # The rule result id.
+          rule_result_id,
+          request_options: {}
+        )
+        end
+
+        # Update a rule result.
+        sig do
+          params(
+            rule_result_id: String,
+            assignee_id: T.nilable(String),
+            blocked_by:
+              T::Array[
+                Openlayer::Governance::RuleResultUpdateParams::BlockedBy::OrHash
+              ],
+            blocking:
+              T::Array[
+                Openlayer::Governance::RuleResultUpdateParams::Blocking::OrHash
+              ],
+            deactivated: T::Boolean,
+            deactivated_reason: T.nilable(String),
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Governance::RuleResultUpdateResponse)
+        end
+        def update(
+          # The rule result id.
+          rule_result_id,
+          # The user responsible for this result.
+          assignee_id: nil,
+          # Rule results that must pass before this one can be satisfied.
+          blocked_by: nil,
+          # Rule results that this one blocks.
+          blocking: nil,
+          # Whether this result is excluded from compliance calculations. Excludes just this
+          # result, without deactivating the rule everywhere.
+          deactivated: nil,
+          # Why the result was excluded. Required when setting `deactivated` to `true`.
+          deactivated_reason: nil,
+          request_options: {}
+        )
+        end
+
+        # List the rule results in a workspace.
+        sig do
+          params(
+            workspace_id: String,
+            enabled_framework_only: T::Boolean,
+            framework_id: String,
+            include_unframed: T::Boolean,
+            page: Integer,
+            per_page: Integer,
+            project_id: String,
+            rule_id: String,
+            scope: Openlayer::Governance::RuleResultListParams::Scope::OrSymbol,
+            search_query: String,
+            status:
+              Openlayer::Governance::RuleResultListParams::Status::OrSymbol,
+            type: Openlayer::Governance::RuleResultListParams::Type::OrSymbol,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Governance::RuleResultListResponse)
+        end
+        def list(
+          # The workspace id.
+          workspace_id,
+          # Only include items belonging to at least one enabled framework.
+          enabled_framework_only: nil,
+          # Only include items belonging to this framework.
+          framework_id: nil,
+          # Whether to include rules that are not part of any framework.
+          include_unframed: nil,
+          # The page to return in a paginated query.
+          page: nil,
+          # Maximum number of items to return per page.
+          per_page: nil,
+          # Only include items that apply to this project.
+          project_id: nil,
+          # Only include results of this rule.
+          rule_id: nil,
+          # Only include rules with this scope.
+          scope: nil,
+          # Filter by a free-text search over names and descriptions.
+          search_query: nil,
+          # Only include items whose rule result has this compliance status.
+          status: nil,
+          # Only include rules of this type.
+          type: nil,
+          request_options: {}
+        )
+        end
+
+        # Attach evidence to a rule result.
+        sig do
+          params(
+            rule_result_id: String,
+            description: T.nilable(String),
+            name: T.nilable(String),
+            storage_uri: T.nilable(String),
+            text: T.nilable(String),
+            url: T.nilable(String),
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(
+            Openlayer::Models::Governance::RuleResultCreateEvidenceResponse
+          )
+        end
+        def create_evidence(
+          # The rule result id.
+          rule_result_id,
+          # A description of what the evidence shows.
+          description: nil,
+          # The evidence name.
+          name: nil,
+          # Where the uploaded file is stored. Set when the rule's `evidenceType` is
+          # `document`. Upload the file first with `POST /storage/presigned-url` and send
+          # the storage URI it returns.
+          storage_uri: nil,
+          # The evidence text. Set when the rule's `evidenceType` is `text`.
+          text: nil,
+          # A link to the evidence. Set when the rule's `evidenceType` is `url`.
+          url: nil,
+          request_options: {}
+        )
+        end
+
+        # List the evidence attached to a rule result.
+        sig do
+          params(
+            rule_result_id: String,
+            page: Integer,
+            per_page: Integer,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(
+            Openlayer::Models::Governance::RuleResultListEvidenceResponse
+          )
+        end
+        def list_evidence(
+          # The rule result id.
+          rule_result_id,
+          # The page to return in a paginated query.
+          page: nil,
+          # Maximum number of items to return per page.
+          per_page: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Openlayer::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/resources/governance/rule_stats.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Openlayer
+  module Resources
+    class Governance
+      class RuleStats
+        # Get compliance statistics for a workspace.
+        sig do
+          params(
+            workspace_id: String,
+            framework_id: String,
+            project_id: String,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Governance::RuleStatRetrieveResponse)
+        end
+        def retrieve(
+          # The workspace id.
+          workspace_id,
+          # Only include items belonging to this framework.
+          framework_id: nil,
+          # Only include items that apply to this project.
+          project_id: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Openlayer::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/resources/governance/rule_tags.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Openlayer
+  module Resources
+    class Governance
+      class RuleTags
+        # List the rule tags in a workspace.
+        sig do
+          params(
+            workspace_id: String,
+            page: Integer,
+            per_page: Integer,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Governance::RuleTagListResponse)
+        end
+        def list(
+          # The workspace id.
+          workspace_id,
+          # The page to return in a paginated query.
+          page: nil,
+          # Maximum number of items to return per page.
+          per_page: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Openlayer::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/resources/governance/rules.rbi

@@ -0,0 +1,209 @@
+# typed: strong
+
+module Openlayer
+  module Resources
+    class Governance
+      class Rules
+        # Create a rule in a workspace.
+        sig do
+          params(
+            workspace_id: String,
+            name: String,
+            scope: Openlayer::Governance::RuleCreateParams::Scope::OrSymbol,
+            type: Openlayer::Governance::RuleCreateParams::Type::OrSymbol,
+            assignee_id: T.nilable(String),
+            automation_params: T.nilable(T::Hash[Symbol, T.anything]),
+            automation_type: T.nilable(String),
+            deactivated: T::Boolean,
+            description: T.nilable(String),
+            evidence_type:
+              T.nilable(
+                Openlayer::Governance::RuleCreateParams::EvidenceType::OrSymbol
+              ),
+            renewal_cadence_days: T.nilable(Integer),
+            tag_ids: T.nilable(T::Array[String]),
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Governance::RuleCreateResponse)
+        end
+        def create(
+          # The workspace id.
+          workspace_id,
+          # The rule name.
+          name:,
+          # Whether the rule is evaluated once for the whole workspace, or once per project
+          # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
+          # the rule is created.
+          scope:,
+          # `platform` rules are evaluated automatically from the state of your Openlayer
+          # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
+          # rule is created.
+          type:,
+          # The user responsible for satisfying the rule.
+          assignee_id: nil,
+          # Configuration for the platform check, when the automation takes parameters. Omit
+          # or `null` for evidence rules. Fixed once the rule is created.
+          automation_params: nil,
+          # Which workspace signal a platform rule checks, for example
+          # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. Set it for
+          # platform rules; omit or `null` for evidence rules. Fixed once the rule is
+          # created.
+          automation_type: nil,
+          # Whether the rule is excluded from compliance calculations.
+          deactivated: nil,
+          # What the rule requires.
+          description: nil,
+          # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
+          # `null` for platform rules. Fixed once the rule is created.
+          evidence_type: nil,
+          # How often evidence must be renewed, in days. Once evidence is older than this,
+          # the rule result becomes `due_soon` and then `failing`. The window restarts
+          # whenever evidence is attached. Omit or `null` for platform rules.
+          renewal_cadence_days: nil,
+          # The ids of the rule tags to associate with the rule. Replaces the rule's tags.
+          # Read them back from `tags`, and list the tags available in the workspace with
+          # `GET /workspaces/{workspaceId}/rule-tags`.
+          tag_ids: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieve a rule with its frameworks and tags.
+        sig do
+          params(
+            rule_id: String,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Governance::RuleRetrieveResponse)
+        end
+        def retrieve(
+          # The rule id.
+          rule_id,
+          request_options: {}
+        )
+        end
+
+        # Update a rule.
+        sig do
+          params(
+            rule_id: String,
+            assignee_id: T.nilable(String),
+            deactivated: T::Boolean,
+            description: T.nilable(String),
+            name: String,
+            renewal_cadence_days: T.nilable(Integer),
+            tag_ids: T.nilable(T::Array[String]),
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Governance::RuleUpdateResponse)
+        end
+        def update(
+          # The rule id.
+          rule_id,
+          # The user responsible for satisfying the rule.
+          assignee_id: nil,
+          # Whether the rule is excluded from compliance calculations.
+          deactivated: nil,
+          # What the rule requires.
+          description: nil,
+          # The rule name.
+          name: nil,
+          # How often evidence must be renewed, in days. Once evidence is older than this,
+          # the rule result becomes `due_soon` and then `failing`. The window restarts
+          # whenever evidence is attached. Omit or `null` for platform rules.
+          renewal_cadence_days: nil,
+          # The ids of the rule tags to associate with the rule. Replaces the rule's tags.
+          # Read them back from `tags`, and list the tags available in the workspace with
+          # `GET /workspaces/{workspaceId}/rule-tags`.
+          tag_ids: nil,
+          request_options: {}
+        )
+        end
+
+        # List the rules in a workspace.
+        sig do
+          params(
+            workspace_id: String,
+            asc: T::Boolean,
+            assignee_id: String,
+            deactivated: T::Boolean,
+            enabled_framework_only: T::Boolean,
+            framework_id: String,
+            group: Openlayer::Governance::RuleListParams::Group::OrSymbol,
+            include_results: T::Boolean,
+            include_unframed: T::Boolean,
+            page: Integer,
+            per_page: Integer,
+            project_id: String,
+            scope: Openlayer::Governance::RuleListParams::Scope::OrSymbol,
+            search_query: String,
+            sort_by: Openlayer::Governance::RuleListParams::SortBy::OrSymbol,
+            status: Openlayer::Governance::RuleListParams::Status::OrSymbol,
+            tags: T::Array[String],
+            type: Openlayer::Governance::RuleListParams::Type::OrSymbol,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Governance::RuleListResponse)
+        end
+        def list(
+          # The workspace id.
+          workspace_id,
+          # Whether to sort in ascending order.
+          asc: nil,
+          # Only include rules assigned to this user.
+          assignee_id: nil,
+          # Only include rules that are deactivated (or active).
+          deactivated: nil,
+          # Only include items belonging to at least one enabled framework.
+          enabled_framework_only: nil,
+          # Only include items belonging to this framework.
+          framework_id: nil,
+          # Only include rules in one bucket of the compliance workflow. `open` covers rules
+          # that still need attention, `done` covers rules that are fully satisfied, and
+          # `excluded` covers rules that have been deactivated.
+          group: nil,
+          # Whether to include each rule's results inline, in a `results` array.
+          include_results: nil,
+          # Whether to include rules that are not part of any framework.
+          include_unframed: nil,
+          # The page to return in a paginated query.
+          page: nil,
+          # Maximum number of items to return per page.
+          per_page: nil,
+          # Only include items that apply to this project.
+          project_id: nil,
+          # Only include rules with this scope.
+          scope: nil,
+          # Filter by a free-text search over names and descriptions.
+          search_query: nil,
+          # The field to sort on.
+          sort_by: nil,
+          # Only include items whose rule result has this compliance status.
+          status: nil,
+          # Only include rules carrying all of these rule tags. Pass tag ids, which you can
+          # look up with [List rule tags](/api-reference/rest/governance/list-rule-tags).
+          tags: nil,
+          # Only include rules of this type.
+          type: nil,
+          request_options: {}
+        )
+        end
+
+        # Delete a rule and its results.
+        sig do
+          params(
+            rule_id: String,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # The rule id.
+          rule_id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Openlayer::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end